Updates README(s)

2026-01-29 21:17:16 +03:00
parent b7041cab1c
commit 7b54465c5f
2 changed files with 165 additions and 109 deletions
--- a/README.md
+++ b/README.md
@@ -1,126 +1,58 @@
 # HAOS Integrations

-A collection of custom Home Assistant integrations.
+A collection of custom integrations for Home Assistant.

-## Integrations
+## Repository Structure

-### Immich Album Watcher
-
-<img src="immich_album_watcher/icon.png" alt="Immich" width="64" height="64">
-
-Monitors [Immich](https://immich.app/) photo/video library albums for changes and exposes them as Home Assistant entities with event-firing capabilities.
-
-#### Features
-
- **Album Monitoring** - Watch selected Immich albums for asset additions and removals
- **Rich Sensor Data** - Multiple sensors per album:
-  - Asset count (total)
-  - Photo count
-  - Video count
-  - People count (detected faces)
-  - Last updated timestamp
-  - Creation date
- **Camera Entity** - Album thumbnail displayed as a camera entity for dashboards
- **Binary Sensor** - "New Assets" indicator that turns on when assets are added
- **Face Recognition** - Detects and lists people recognized in album photos
- **Event Firing** - Fires Home Assistant events when albums change:
-  - `immich_album_watcher_album_changed` - General album changes
-  - `immich_album_watcher_assets_added` - When new assets are added
-  - `immich_album_watcher_assets_removed` - When assets are removed
- **Enhanced Event Data** - Events include detailed asset info:
-  - Asset type (photo/video)
-  - Filename
-  - Creation date
-  - Detected people in the asset
- **Services** - Custom service calls:
-  - `immich_album_watcher.refresh` - Force immediate data refresh
-  - `immich_album_watcher.get_recent_assets` - Get recent assets from an album
- **Configurable Polling** - Adjustable scan interval (10-3600 seconds)
-
-#### Entities Created (per album)
-
-| Entity Type | Name | Description |
-|-------------|------|-------------|
-| Sensor | Asset Count | Total number of assets in the album |
-| Sensor | Photo Count | Number of photos in the album |
-| Sensor | Video Count | Number of videos in the album |
-| Sensor | People Count | Number of unique people detected |
-| Sensor | Last Updated | When the album was last modified |
-| Sensor | Created | When the album was created |
-| Binary Sensor | New Assets | On when new assets were recently added |
-| Camera | Thumbnail | Album cover image |
-
-#### Installation
-
-1. Copy the `immich_album_watcher` folder to your Home Assistant `custom_components` directory
-2. Restart Home Assistant
-3. Go to **Settings** → **Devices & Services** → **Add Integration**
-4. Search for "Immich Album Watcher"
-5. Enter your Immich server URL and API key
-6. Select the albums you want to monitor
-
-#### Configuration
-
-| Option | Description | Default |
-|--------|-------------|---------|
-| Server URL | Your Immich server URL (e.g., `https://immich.example.com`) | Required |
-| API Key | Your Immich API key | Required |
-| Albums | Albums to monitor | Required |
-| Scan Interval | How often to check for changes (seconds) | 60 |
-
-#### Services
-
-##### Refresh
-
-Force an immediate refresh of all album data:
-
-```yaml
-service: immich_album_watcher.refresh
+```
+haos-integrations/
+├── immich_album_watcher/    # Immich Album Watcher integration
+│   ├── __init__.py
+│   ├── binary_sensor.py
+│   ├── camera.py
+│   ├── config_flow.py
+│   ├── const.py
+│   ├── coordinator.py
+│   ├── manifest.json
+│   ├── sensor.py
+│   ├── services.yaml
+│   ├── strings.json
+│   ├── icon.png
+│   ├── README.md
+│   └── translations/
+│       ├── en.json
+│       └── ru.json
+├── .gitignore
+├── LICENSE
+└── README.md
 ```

-##### Get Recent Assets
+## Available Integrations

-Get the most recent assets from a specific album (returns response data):
+| Integration | Description | Documentation |
+|-------------|-------------|---------------|
+| [Immich Album Watcher](immich_album_watcher/) | Monitor Immich albums for changes with sensors, events, and face recognition | [README](immich_album_watcher/README.md) |

-```yaml
-service: immich_album_watcher.get_recent_assets
-data:
-  album_id: "your-album-id-here"
-  count: 10
-```
+## Installation

-#### Events
+### Manual Installation

-Use these events in your automations:
+1. Download or clone this repository
+2. Copy the desired integration folder (e.g., `immich_album_watcher`) to your Home Assistant `custom_components` directory
+3. Restart Home Assistant
+4. Add the integration via **Settings** → **Devices & Services** → **Add Integration**

-```yaml
-automation:
-  - alias: "New photos added to album"
-    trigger:
-      - platform: event
-        event_type: immich_album_watcher_assets_added
-    action:
-      - service: notify.mobile_app
-        data:
-          title: "New Photos"
-          message: "{{ trigger.event.data.added_count }} new photos in {{ trigger.event.data.album_name }}"
-```
+### HACS Installation

-Event data includes:
- `album_id` - Album ID
- `album_name` - Album name
- `change_type` - Type of change (assets_added, assets_removed, changed)
- `added_count` - Number of assets added
- `removed_count` - Number of assets removed
- `added_assets` - List of added assets with details (type, filename, created date, people)
- `removed_assets` - List of removed asset IDs
- `people` - List of all people detected in the album
+1. Open HACS in Home Assistant
+2. Go to **Integrations** → **Custom repositories**
+3. Add this repository URL
+4. Install the desired integration
+5. Restart Home Assistant

-#### Requirements
+## Contributing

- Home Assistant 2024.1.0 or newer
- Immich server with API access
- Valid Immich API key with `album.read` and `asset.read` permissions
+Contributions are welcome! Please feel free to submit issues or pull requests.

 ## License