refactor: rename "Rooms" integration to "Custom Areas" (#5)

* refactor: rename "Rooms" integration to "Custom Areas"

Rename the entire "Rooms" integration to "Custom Areas" to better
reflect its functionality and usage. The renaming affects:
- directory and file names: custom_components/rooms -> custom_components/areas
- documentation, comments, and strings references to the "Rooms" entity
- README and other markdown files to clarify the new scope
- update entity IDs and names to use "area_" prefixes

This change aligns the integration's name with its features of managing
custom area sensors in Home Assistant, providing clarity to users and
developers.

* Update .github/workflows/ci.yml

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: DefinitelyADev

.github/workflows/ci.yml

@@ -124,8 +124,8 @@ jobs:
 
     - name: Run linting
       run: |
-        black --check --diff custom_components/rooms/
-        isort --check-only --diff custom_components/rooms/
-        flake8 custom_components/rooms/
-        ruff check custom_components/rooms/
-        cd custom_components && python -m mypy rooms/
+        black --check --diff custom_components/areas/
+        isort --check-only --diff custom_components/areas/
+        flake8 custom_components/areas/
+        ruff check custom_components/areas/
+        cd custom_components && python -m mypy areas/

.github/workflows/manual-validation.yml

@@ -75,9 +75,9 @@ jobs:
 
     - name: Run linting
       run: |
-        black --check --diff custom_components/rooms/
-        isort --check-only --diff custom_components/rooms/
-        flake8 custom_components/rooms/
+        black --check --diff custom_components/areas/
+        isort --check-only --diff custom_components/areas/
+        flake8 custom_components/areas/
 
   manual-type-check:
     if: inputs.validation_type == 'all' || inputs.validation_type == 'type-check'

README.md

@@ -1,19 +1,19 @@
-# Rooms Integration for Home Assistant
+# Custom Areas Integration for Home Assistant
 
-A custom integration for Home Assistant that creates composite "Room" sensors with UI configuration.
+A custom integration for Home Assistant that creates composite "Area" sensors with UI configuration.
 
 ## Features
 
-- **UI Configuration**: Add rooms through Home Assistant's UI with an intuitive config flow
-- **Composite Sensors**: Each room creates a summary sensor that combines multiple entity states
+- **UI Configuration**: Add areas through Home Assistant's UI with an intuitive config flow
+- **Composite Sensors**: Each area creates a summary sensor that combines multiple entity states
 - **Real-time Updates**: Uses event-driven updates instead of polling for instant state changes
 - **Device Registry**: Creates proper devices in Home Assistant's device registry
 
 ## Documentation
 
 📖 **Complete Documentation**: [docs/](docs/)
 
-- **[Design Rationale](docs/rationale.md)** - Why this exists and how it pairs with CFHAC/Area-like UX
+- **[Design Rationale](docs/rationale.md)** - Why this exists and how it pairs with Custom Features for Home Assistant Cards/Area-like UX
 - **[API Reference](docs/api.md)** - Entity states, attributes, and configuration schema
 - **[Configuration Examples](docs/examples.md)** - Real-world setup examples and use cases
 - **[Developer Guide](docs/developer.md)** - Architecture overview and development setup
@@ -43,40 +43,40 @@ Not affiliated with Home Assistant — just vibing on top of it.
    - Select "Custom repositories"
    - Add: `https://github.com/DefinitelyADev/room-entity`
    - Category: Integration
-3. Search for "Rooms" in HACS and install it
+3. Search for "Areas" in HACS and install it
 4. Restart Home Assistant
 
 ### Manual Installation
 
-1. Download the `custom_components/rooms/` folder from this repository
+1. Download the `custom_components/areas/` folder from this repository
 2. Copy it to your Home Assistant's `custom_components/` directory
 3. Restart Home Assistant
 
 ## Configuration
 
-### Adding a Room
+### Adding an Area
 
 1. Go to **Settings** → **Devices & Services** → **Add Integration**
-2. Search for "Rooms" and select it
-3. Configure your room:
-   - **Room Name**: Display name for the room
+2. Search for "Areas" and select it
+3. Configure your area:
+   - **Area Name**: Display name for the area
    - **Power Sensor**: Optional sensor for power consumption
    - **Energy Sensor**: Optional sensor for energy consumption
    - **Temperature Sensor**: Optional temperature sensor
    - **Humidity Sensor**: Optional humidity sensor
    - **Motion Sensor**: Optional motion detection sensor
    - **Window Sensor**: Optional window/door sensor
    - **Climate Entity**: Optional climate control entity
-   - **Active Power Threshold**: Power level (in watts) above which the room is considered "active"
+   - **Active Power Threshold**: Power level (in watts) above which the area is considered "active"
 
 ## Usage
 
 ### Summary Sensor
 
-Each room creates a summary sensor with these states:
-- **active**: Room is currently active (motion detected OR power above threshold)
-- **idle**: Room has configured entities but is not active
-- **unknown**: No entities configured for the room
+Each area creates a summary sensor with these states:
+- **active**: Area is currently active (motion detected OR power above threshold)
+- **idle**: Area has configured entities but is not active
+- **unknown**: No entities configured for the area
 
 The summary sensor includes these attributes:
 - `power_w` (numeric) and `power` (string with unit, e.g. "28.6 W")
@@ -88,39 +88,39 @@ The summary sensor includes these attributes:
 - `climate_mode`: Current climate mode
    - `climate_target_c` (numeric) and `climate_target` (string with unit)
 
-### Area vs Tile (with CFHAC)
+### Area vs Tile (with Custom Features for Home Assistant Cards)
 
-If you want to mimic the Area card using a Tile card with CFHAC features and the room summary sensor:
+If you want to mimic the Area card using a Tile card with Custom Features for Home Assistant Cards features and the area summary sensor:
 
-![Area card vs Tile card with CFHAC](docs/images/area-vs-tile.png)
+![Area card vs Tile card with Custom Features for Home Assistant Cards](docs/images/area-vs-tile.png)
 
 ## State Logic
 
-The room state is determined by this priority:
+The area state is determined by this priority:
 1. If motion sensor is ON → **active**
 2. If power consumption > active threshold → **active**
 3. If any core entities exist but conditions 1-2 are false → **idle**
 4. If no entities configured → **unknown**
 
 ## Icons
 
-The summary sensor icon changes based on room status:
+The summary sensor icon changes based on area status:
 - Window open: `mdi:window-open-variant`
 - Motion detected: `mdi:motion-sensor`
 - Default: `mdi:home`
 
 ## Device Registry
 
-Each room creates a device in Home Assistant's device registry, allowing you to:
-- Group all room sensors together
+Each area creates a device in Home Assistant's device registry, allowing you to:
+- Group all area sensors together
 - View device information
 - Manage device settings
 
 ## Requirements
 
 - Home Assistant 2024.1.0 or later
 - Python 3.10 or later
-- Entities must exist before configuring the room
+- Entities must exist before configuring the area
 
 ## Troubleshooting
 
@@ -137,7 +137,7 @@ Add this to your `configuration.yaml` to enable debug logging:
 logger:
   default: info
   logs:
-    custom_components.rooms: debug
+    custom_components.areas: debug
 ```
 
 ## Contributing
@@ -182,9 +182,9 @@ Or run individual checks:
 python validate.py          # Custom validation
 python run_tests.py         # Unit tests
 pyright                    # Type checking
-black --check custom_components/rooms/    # Code formatting
-isort --check-only custom_components/rooms/  # Import sorting
-flake8 custom_components/rooms/           # Linting
+black --check custom_components/areas/    # Code formatting
+isort --check-only custom_components/areas/  # Import sorting
+flake8 custom_components/areas/           # Linting
 ```
 
 ### Pre-commit Setup

check_all.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-"""Run all validations and checks for the Rooms integration."""
+"""Run all validations and checks for the Custom Areas Integration."""
 
 import subprocess
 import sys
@@ -23,12 +23,12 @@ def run_command(cmd, description):
 
 def main():
     """Run all validations."""
-    print("🚀 Running all validations for Rooms integration...")
+    print("🚀 Running all validations for Custom Areas Integration...")
 
     all_passed = True
 
     # Check if we're in the right directory
-    if not Path("custom_components/rooms").exists():
+    if not Path("custom_components/areas").exists():
         print("❌ Not in the correct directory. Please run from the project root.")
         return 1
 
@@ -45,13 +45,13 @@ def main():
         all_passed = False
 
     # Run linting
-    if not run_command("black --check --diff custom_components/rooms/", "Black formatting check"):
+    if not run_command("black --check --diff custom_components/areas/", "Black formatting check"):
         all_passed = False
 
-    if not run_command("isort --check-only --diff custom_components/rooms/", "Import sorting check"):
+    if not run_command("isort --check-only --diff custom_components/areas/", "Import sorting check"):
         all_passed = False
 
-    if not run_command("flake8 custom_components/rooms/", "Flake8 linting"):
+    if not run_command("flake8 custom_components/areas/", "Flake8 linting"):
         all_passed = False
 
     # Run pre-commit (if available)

custom_components/rooms/__init__.py renamed to custom_components/areas/__init__.py

@@ -1,4 +1,4 @@
-"""Rooms integration for Home Assistant."""
+"""Custom Areas Integration for Home Assistant."""
 
 import logging
 
@@ -8,19 +8,19 @@
 from homeassistant.helpers import device_registry as dr
 
 from .const import DOMAIN
-from .sensor import RoomSensorCoordinator
+from .sensor import AreaSensorCoordinator
 
 _LOGGER = logging.getLogger(__name__)
 
 PLATFORMS = ["sensor"]
 
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
-    """Set up rooms from a config entry."""
-    _LOGGER.info("Setting up rooms integration for %s", entry.title)
+    """Set up areas from a config entry."""
+    _LOGGER.info("Setting up areas integration for %s", entry.title)
 
     try:
-        coordinator = RoomSensorCoordinator(hass, entry)
+        coordinator = AreaSensorCoordinator(hass, entry)
         await coordinator.async_config_entry_first_refresh()
 
         hass.data.setdefault(DOMAIN, {})
@@ -31,9 +31,9 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         device_registry.async_get_or_create(
             config_entry_id=entry.entry_id,
             identifiers={(DOMAIN, entry.entry_id)},
-            name=f"Room: {entry.data.get('room_name', 'Unknown')}",
-            manufacturer="Rooms Integration",
-            model="Room Sensor",
+            name=f"Area: {entry.data.get('area_name', 'Unknown')}",
+            manufacturer="Areas Integration",
+            model="Area Sensor",
         )
 
         await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
@@ -43,7 +43,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         return True
 
     except Exception as ex:
-        _LOGGER.error("Error setting up rooms integration: %s", ex)
+        _LOGGER.error("Error setting up areas integration: %s", ex)
         _LOGGER.error("Exception type: %s", type(ex).__name__)
         import traceback
 
@@ -53,7 +53,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
 
 async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Unload a config entry."""
-    _LOGGER.info("Unloading rooms integration for %s", entry.title)
+    _LOGGER.info("Unloading areas integration for %s", entry.title)
 
     unload_ok: bool = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
 

custom_components/rooms/config_flow.py renamed to custom_components/areas/config_flow.py

@@ -1,4 +1,4 @@
-"""Config flow for Rooms integration."""
+"""Config flow for Custom Areas Integration."""
 
 import logging
 from typing import Any, Dict, Optional
@@ -10,13 +10,13 @@
 
 from .const import (
     CONF_ACTIVE_THRESHOLD,
+    CONF_AREA_NAME,
     CONF_CLIMATE_ENTITY,
     CONF_ENERGY_ENTITY,
     CONF_HUMIDITY_ENTITY,
     CONF_ICON,
     CONF_MOTION_ENTITY,
     CONF_POWER_ENTITY,
-    CONF_ROOM_NAME,
     CONF_TEMP_ENTITY,
     CONF_WINDOW_ENTITY,
     DEFAULT_ICON,
@@ -26,10 +26,10 @@
 _LOGGER = logging.getLogger(__name__)
 
 
-class RoomsConfigFlow(
+class AreasConfigFlow(
     config_entries.ConfigFlow, domain=DOMAIN
 ):  # type: ignore[call-arg]  # HA's __init_subclass__ accepts domain parameter
-    """Handle a config flow for Rooms."""
+    """Handle a config flow for Areas."""
 
     VERSION = 1
     DOMAIN = DOMAIN
@@ -43,24 +43,24 @@ async def async_step_user(self, user_input: Optional[Dict[str, Any]] = None) ->
         errors: Dict[str, str] = {}
 
         if user_input is not None:
-            # Validate room name is unique
-            await self.async_set_unique_id(user_input[CONF_ROOM_NAME])
+            # Validate area name is unique
+            await self.async_set_unique_id(user_input[CONF_AREA_NAME])
             self._abort_if_unique_id_configured()
 
             # Ensure icon has a default value if not provided
             if CONF_ICON not in user_input or user_input[CONF_ICON] is None:
                 user_input[CONF_ICON] = DEFAULT_ICON
 
             return self.async_create_entry(
-                title=user_input[CONF_ROOM_NAME],
+                title=user_input[CONF_AREA_NAME],
                 data=user_input,
             )  # pyright: ignore[reportReturnType]
 
         return self.async_show_form(
             step_id="user",
             data_schema=vol.Schema(
                 {
-                    vol.Required(CONF_ROOM_NAME): str,
+                    vol.Required(CONF_AREA_NAME): str,
                     vol.Optional(CONF_ICON): selector.IconSelector(
                         selector.IconSelectorConfig(placeholder="mdi:texture-box")
                     ),

custom_components/rooms/const.py renamed to custom_components/areas/const.py

@@ -1,7 +1,7 @@
-"""Constants for the Rooms integration."""
+"""Constants for the Custom Areas Integration."""
 
-DOMAIN = "rooms"
-CONF_ROOM_NAME = "room_name"
+DOMAIN = "areas"
+CONF_AREA_NAME = "area_name"
 CONF_POWER_ENTITY = "power_entity"
 CONF_ENERGY_ENTITY = "energy_entity"
 CONF_TEMP_ENTITY = "temp_entity"

custom_components/rooms/manifest.json renamed to custom_components/areas/manifest.json

@@ -1,6 +1,6 @@
 {
-  "domain": "rooms",
-  "name": "Rooms",
+  "domain": "areas",
+  "name": "Custom Areas Integration",
   "codeowners": ["@DefinitelyADev"],
   "config_flow": true,
   "dependencies": [],