Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 981f56a693 | |||
| f6bd04f354 | |||
| 8da8a26a90 | |||
| 42fe5afe52 | |||
| 437c020566 | |||
| b863ed4d51 | |||
| 368642345d | |||
| 43bc31c8b4 | |||
| 357049aa7b | |||
| d85ef5621c | |||
| faac180212 | |||
| 76d8a45f37 | |||
| d68d322df6 | |||
| 113c951028 | |||
| 2a4ab676ec | |||
| c0a04f505e | |||
| a63006bb07 | |||
| f8e678215d | |||
| f745f8ec1e |
43
CHANGELOG.md
43
CHANGELOG.md
@@ -11,6 +11,49 @@ Sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## [0.6.9] – 2026-01-19
|
||||||
|
### Added
|
||||||
|
- New Home Assistant **GUI setup** (Config Flow) – no YAML configuration required.
|
||||||
|
- Optional **GitHub Token** support to increase API limits (up to 5000 req/h).
|
||||||
|
Configurable via *Integration → Options*.
|
||||||
|
- Clear setup guidance and warning about GitHub rate limits.
|
||||||
|
- Automatic detection and warning if YAML setup is still present (ignored safely).
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- **store.yaml** URL is now fixed to the official Bahmcloud Store index:
|
||||||
|
https://git.bahmcloud.de/bahmcloud/ha_store/raw/branch/main/store.yaml
|
||||||
|
- Installation workflow fully aligned with standard HA integrations.
|
||||||
|
- Update platform migrated to `async_setup_entry`.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Minor stability and persistence improvements in startup sequence.
|
||||||
|
- Prevented duplicate background initialization when HA reloads the integration.
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
- To enable extended GitHub access, create a fine-grained personal access token
|
||||||
|
(read-only) at https://github.com/settings/tokens and add it via the integration options.
|
||||||
|
|
||||||
|
## 0.6.8 – Performance & Cache Stabilization (2026-01-19)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fixed excessive GitHub API requests causing rate limiting
|
||||||
|
- Fixed missing persistence of repository versions and metadata
|
||||||
|
- Fixed background enrichment re-running after Home Assistant restart
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Repository metadata (versions, README, descriptions) is now fetched once in the background
|
||||||
|
- Cached data is reused and only refreshed on explicit user interaction
|
||||||
|
- Improved separation between startup refresh and on-demand updates
|
||||||
|
|
||||||
|
### Improved
|
||||||
|
- Significantly reduced Home Assistant startup time
|
||||||
|
- Greatly reduced GitHub API usage
|
||||||
|
- More reliable version selection for GitHub and HACS repositories
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
- Background tasks may still appear in DEBUG logs (expected behavior)
|
||||||
|
- No functional UI changes in this release
|
||||||
|
|
||||||
## [0.6.7] - 2026-01-19
|
## [0.6.7] - 2026-01-19
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|||||||
51
README.md
51
README.md
@@ -1,3 +1,50 @@
|
|||||||
# bahmcloud_store
|
# Bahmcloud Store (BCS) for Home Assistant
|
||||||
|
|
||||||
Bahmcloud Store for installing costum_components to Homeassistant
|
Bahmcloud Store (BCS) is a provider-neutral store for Home Assistant custom integrations.
|
||||||
|
It allows you to browse, install, update, downgrade, uninstall and restore integrations
|
||||||
|
directly from the Home Assistant UI.
|
||||||
|
|
||||||
|
This README is intended for **end users**.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Option A: Home Assistant OS / Supervised (Add-on – recommended)
|
||||||
|
|
||||||
|
1. Open **Settings → Add-ons → Add-on Store**
|
||||||
|
2. Add the Bahmcloud Add-on repository
|
||||||
|
`https://git.bahmcloud.de/bahmcloud/addons`
|
||||||
|
3. Install **Bahmcloud Store Installer**
|
||||||
|
4. Start the add-on
|
||||||
|
5. Restart Home Assistant
|
||||||
|
|
||||||
|
Installed to:
|
||||||
|
/config/custom_components/bahmcloud_store
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Option B: Manual Installation (Container / Core)
|
||||||
|
|
||||||
|
1. Download the latest release
|
||||||
|
2. Copy `custom_components/bahmcloud_store` to:
|
||||||
|
/config/custom_components/bahmcloud_store
|
||||||
|
3. Restart Home Assistant
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Repository Sources
|
||||||
|
|
||||||
|
- **BCS Official**
|
||||||
|
- **HACS**
|
||||||
|
- **Custom**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
Developer documentation:
|
||||||
|
https://git.bahmcloud.de/bahmcloud/bahmcloud_store/src/branch/main/README_DEVELOPER.md
|
||||||
|
|
||||||
|
Full technical documentation:
|
||||||
|
https://git.bahmcloud.de/bahmcloud/bahmcloud_store/src/branch/main/README_FULL.md
|
||||||
|
|||||||
115
README_DEVELOPER.md
Normal file
115
README_DEVELOPER.md
Normal file
@@ -0,0 +1,115 @@
|
|||||||
|
# Bahmcloud Store – Developer Documentation
|
||||||
|
|
||||||
|
For contributors and maintainers.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
Repositories:
|
||||||
|
1) Installer Add-on (HAOS/Supervised) ```https://git.bahmcloud.de/bahmcloud/addons```
|
||||||
|
2) Core Integration ```https://git.bahmcloud.de/bahmcloud/bahmcloud_store```
|
||||||
|
3) Store Index (`store.yaml`) ```https://git.bahmcloud.de/bahmcloud/ha_store```
|
||||||
|
|
||||||
|
### Integration Layout
|
||||||
|
|
||||||
|
custom_components/bahmcloud_store/
|
||||||
|
- __init__.py: setup, panel registration, schedule background after HA started
|
||||||
|
- core.py: index merge, enrichment, install/update/uninstall, backups, restore, caching
|
||||||
|
- providers.py: GitHub/GitLab/Gitea repo info + latest version helpers
|
||||||
|
- metadata.py: read bcs.yaml / hacs.json / hacs.yaml
|
||||||
|
- storage.py: persistent storage (installed, custom, repo cache, hacs cache)
|
||||||
|
- views.py: HTTP API endpoints
|
||||||
|
- update.py: UpdateEntity implementation
|
||||||
|
- repairs.py: (optional) Repairs flow for restart
|
||||||
|
- panel/: UI (panel.js, styles.css, etc.)
|
||||||
|
- manifest.json
|
||||||
|
|
||||||
|
## Runtime Model
|
||||||
|
|
||||||
|
- RepoItem (merged)
|
||||||
|
- Installed repos (storage)
|
||||||
|
- Repo cache (persisted enrichment)
|
||||||
|
- HACS meta cache (mapping owner/repo → name/description)
|
||||||
|
|
||||||
|
## Background
|
||||||
|
|
||||||
|
- Heavy work only after `homeassistant_started`
|
||||||
|
- Refresh: if index unchanged → installed-only refresh + schedule enrichment
|
||||||
|
- Opening a repo triggers `ensure_repo_details()` and persists to cache
|
||||||
|
|
||||||
|
## Providers
|
||||||
|
|
||||||
|
- GitHub: API/releases/tags/atom + raw readme
|
||||||
|
- GitLab: API releases/tags + raw readme
|
||||||
|
- Gitea: API releases/tags + raw readme
|
||||||
|
- Custom: API or HTTPS Request to your Git Provider
|
||||||
|
|
||||||
|
## Metadata
|
||||||
|
|
||||||
|
- Prefer `bcs.yaml`, fallback `hacs.json` / `hacs.yaml`
|
||||||
|
- Populate name/description/category/author/maintainer
|
||||||
|
|
||||||
|
## HTTP API (excerpt)
|
||||||
|
|
||||||
|
Base: /api/bcs
|
||||||
|
|
||||||
|
- GET /api/bcs
|
||||||
|
- POST /api/bcs?action=refresh
|
||||||
|
- GET /api/bcs/readme?repo_id=...
|
||||||
|
- GET /api/bcs/versions?repo_id=...
|
||||||
|
- POST /api/bcs/install?repo_id=...&version=...
|
||||||
|
- POST /api/bcs/update?repo_id=...&version=...
|
||||||
|
- POST /api/bcs/uninstall?repo_id=...
|
||||||
|
- GET /api/bcs/backups?repo_id=...
|
||||||
|
- POST /api/bcs/restore?repo_id=...&backup_id=...
|
||||||
|
- (optional) POST/DELETE custom_repo
|
||||||
|
|
||||||
|
## Update Entities
|
||||||
|
|
||||||
|
- Unique id bcs:<repo_id>
|
||||||
|
- Compare installed ref vs latest ref
|
||||||
|
- Dispatcher signal on refresh/install/update
|
||||||
|
|
||||||
|
## Storage
|
||||||
|
|
||||||
|
- JSON in HA `.storage`
|
||||||
|
- async read/write helpers
|
||||||
|
- repo cache applied on startup
|
||||||
|
|
||||||
|
## Contributing to **BCS Official**
|
||||||
|
|
||||||
|
1) Add pull request to `https://git.bahmcloud.de/bahmcloud/ha_store` (with your integration added to) `store.yaml`)
|
||||||
|
2) Add entry:
|
||||||
|
```yaml
|
||||||
|
- name: Your Integration Name
|
||||||
|
url: https://your-git-hoster.com/your-org/your-repo
|
||||||
|
category: Category (actually only "Integrations" are supported)
|
||||||
|
```
|
||||||
|
3) (Recommended) Add `bcs.yaml` to your repo:
|
||||||
|
```yaml
|
||||||
|
name: Your Integration Name
|
||||||
|
description: One-liner for the store (optional, store information are also catched from git repository)
|
||||||
|
category: Integrations (actually only supported)
|
||||||
|
author: Your Name
|
||||||
|
maintainer: Your Handle
|
||||||
|
```
|
||||||
|
4) Open PR; validation checks: reachable, has `custom_components/<domain>/manifest.json`, sensible metadata
|
||||||
|
5) Merge → appears in **BCS Official** after refresh
|
||||||
|
|
||||||
|
## Coding Guidelines
|
||||||
|
|
||||||
|
- Async I/O, no blocking event loop
|
||||||
|
- Respect provider rate limits
|
||||||
|
- Clean logging around refresh/install/update/restore
|
||||||
|
- Keep UI responsive; throttle updates
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Planed Features
|
||||||
|
|
||||||
|
- Add Downloads and install for category "Dashboard"
|
||||||
|
- Add Downloads and install for category "Template"
|
||||||
|
- Add Downloads and install for category "Theme"
|
||||||
|
- Add Downloads and install for category "Blueprint"
|
||||||
|
-
|
||||||
|
|
||||||
|
|
||||||
217
README_FULL.md
Normal file
217
README_FULL.md
Normal file
@@ -0,0 +1,217 @@
|
|||||||
|
# Bahmcloud Store – Full User Guide
|
||||||
|
|
||||||
|
This guide explains **all features** of Bahmcloud Store (BCS) for Home Assistant.
|
||||||
|
It is written for users and admins who want a complete, practical reference.
|
||||||
|
|
||||||
|
> BCS lets you install & manage custom integrations from **GitHub/GitLab/Gitea** and your own sources, with backups, restore, and version pinning.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
- Concepts
|
||||||
|
- Sources (BCS / HACS / Custom)
|
||||||
|
- UI Overview
|
||||||
|
- Finding Integrations
|
||||||
|
- Installing
|
||||||
|
- Selecting Versions / Downgrading
|
||||||
|
- Updating
|
||||||
|
- Uninstalling
|
||||||
|
- Backups & Restore
|
||||||
|
- Custom Repositories
|
||||||
|
- HACS Repositories
|
||||||
|
- Update Entities in Home Assistant
|
||||||
|
- Background Caching & Performance
|
||||||
|
- Restart Required
|
||||||
|
- Troubleshooting
|
||||||
|
- FAQ
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Concepts
|
||||||
|
|
||||||
|
- **Sources**:
|
||||||
|
- **BCS Official** → entries from index (`store.yaml`) made and added from Bahmcloud
|
||||||
|
- **HACS** → official HACS integrations list (toggleable)
|
||||||
|
- **Custom** → manual entries you add locally
|
||||||
|
- **Install location**: `/config/custom_components/<domain>`
|
||||||
|
- **Backup**: BCS keeps pre‑update copies in `/config/.bcs_backups/<domain>/<timestamp>/`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Sources (BCS / HACS / Custom)
|
||||||
|
|
||||||
|
Each repository card shows a **source badge**:
|
||||||
|
- **BCS Official** – from Bahmcloud index
|
||||||
|
- **HACS** – from HACS official list (enable with the toggle)
|
||||||
|
- **Custom** – added by you
|
||||||
|
|
||||||
|
You can **filter by source** with the **Source** dropdown (All / BCS Official / HACS / Custom).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## UI Overview
|
||||||
|
|
||||||
|
Top bar:
|
||||||
|
- **Search** (name/description)
|
||||||
|
- **Source** filter (All/BCS Official/HACS/Custom)
|
||||||
|
- **Category** filter (actually only Integrations are supported)
|
||||||
|
- **State-Filter** filter (All/Installed/Not installed/Update available/Custom repos)
|
||||||
|
- **Sort** (name (A-Z)/Updates first/Installed first)
|
||||||
|
- **HACS official** toggle (on/off)
|
||||||
|
|
||||||
|
Repository card:
|
||||||
|
- Name, description, badges (source, installed/update), category
|
||||||
|
- Buttons: **Install / Update / Uninstall**
|
||||||
|
- **Readme** expandable
|
||||||
|
- **Open** to see details (available versions, metadata)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Finding Integrations
|
||||||
|
|
||||||
|
1. Use **Search** to filter by keywords.
|
||||||
|
2. Combine with **Category** and **Source**.
|
||||||
|
3. Sort to surface desired results.
|
||||||
|
|
||||||
|
Descriptions and latest versions are filled progressively by a background process; opening a repo loads details on demand.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Installing
|
||||||
|
|
||||||
|
1. Open a repository.
|
||||||
|
2. Optionally select **Install version** (default: **Latest**).
|
||||||
|
3. Click **Install** and wait for confirmation.
|
||||||
|
4. Follow the **Restart required** prompt. (or use restart toggle in HomeAssistant Settings)
|
||||||
|
|
||||||
|
**What happens internally**
|
||||||
|
- BCS downloads the repository ZIP for the selected version (release/tag/branch).
|
||||||
|
- It extracts all integrations found under `custom_components/<domain>` and deploys them.
|
||||||
|
- It saves the **installed version (ref)** to track updates reliably, even if the repo’s own `manifest.json` is wrong/outdated.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Selecting Versions / Downgrading
|
||||||
|
|
||||||
|
- Use the **Install version** dropdown in the detail view.
|
||||||
|
- Choose **Latest** or a previous **release/tag**.
|
||||||
|
- Installing a chosen ref **pins** the integration to that ref (no surprise updates).
|
||||||
|
- You can upgrade again later by selecting **Latest** and clicking **Update**.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Updating
|
||||||
|
|
||||||
|
- The **Update** button appears when `latest_version` differs from your **installed version (ref)**.
|
||||||
|
- Updates are also available via **Home Assistant → Settings → Updates** (native Update entity).
|
||||||
|
- Clicking **Update** runs the same safe pipeline as **Install** (with backup).
|
||||||
|
|
||||||
|
**Tip:** Opening a repository detail view forces an immediate check for the latest version for that repo.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Uninstalling
|
||||||
|
|
||||||
|
- Click **Uninstall** on the repository.
|
||||||
|
- BCS removes the integration folders under `custom_components/<domain>`.
|
||||||
|
- The installed state is cleared in the Store.
|
||||||
|
- Restart Home Assistant if prompted.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Backups & Restore
|
||||||
|
|
||||||
|
Before an update/install over existing files, BCS creates a backup:
|
||||||
|
|
||||||
|
```
|
||||||
|
/config/.bcs_backups/<domain>/<timestamp>/
|
||||||
|
```
|
||||||
|
|
||||||
|
**Restore**:
|
||||||
|
1. Open the repository in store.
|
||||||
|
2. Select **Restore…**.
|
||||||
|
3. Pick one of the **last backups** (up to retention limit). (Version details are showed in ())
|
||||||
|
4. Confirm – BCS restores files and reconciles installed version to the restored ref.
|
||||||
|
5. Restart Home Assistant if prompted.
|
||||||
|
|
||||||
|
If the old backup lacks metadata, BCS best‑effort derives the installed version from the backup’s `manifest.json`, or marks the ref as `restored:<timestamp>` so updates remain possible.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Custom Repositories
|
||||||
|
|
||||||
|
You can add any public repository (GitHub/GitLab/Gitea/Any other Git Hoster). BCS will attempt to detect:
|
||||||
|
- provider & default branch
|
||||||
|
- latest version (release/tag/atom)
|
||||||
|
- repo metadata (prefer `bcs.yaml`, fallback `hacs.json/hacs.yaml`)
|
||||||
|
- readme (common filenames)
|
||||||
|
|
||||||
|
**Add an custom repository**(typical flows):
|
||||||
|
- From the Store UI
|
||||||
|
1. If you start up Bahmcloud Store, you are on tab "Store"
|
||||||
|
2. Go to tab "Manage"
|
||||||
|
3. Add Repository URL (Example: ``https://git.bahmcloud.de/bahmcloud/bahmcloud_store``) and (optional) Name you want to show up (will be grabbed from GIT Repository)
|
||||||
|
4. Repository show up in Custom Repositories-list and in "Store" Tab, if available
|
||||||
|
|
||||||
|
**Remove an custom repository**(typical flows):
|
||||||
|
- From the Store UI
|
||||||
|
1. If you start up Bahmcloud Store, you are on tab "Store"
|
||||||
|
2. Go to tab "Manage"
|
||||||
|
3. Your repository you want to remove (if its custom) show up in the list
|
||||||
|
4. Press "Remove" Button to delete from Store (Attention: If you Remove installed Repository, you won´t be able to Uninstall from Store, you have to remove by your own (Delete Folder from ```config/custom_components/*```))
|
||||||
|
|
||||||
|
Custom repos get the **Custom** badge and can be filtered via **Source**.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## HACS Repositories
|
||||||
|
|
||||||
|
Enable the **HACS official** toggle to include official HACS integrations.
|
||||||
|
|
||||||
|
- BCS downloads the HACS integration list and maps **human‑readable names/descriptions** from HACS metadata.
|
||||||
|
- HACS entries are **not** part of your BCS-Official Repositories (avoid duplicate entries).
|
||||||
|
|
||||||
|
With many HACS repos, metadata loads in the background; names/descriptions appear progressively and are cached.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Update Entities in Home Assistant
|
||||||
|
|
||||||
|
BCS exposes update entities for installed repos:
|
||||||
|
- Found under **Settings → Updates**
|
||||||
|
- Clicking **Install** triggers BCS update pipeline
|
||||||
|
- Shows **installed** and **latest** versions (BCS ref logic)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Background Caching & Performance
|
||||||
|
|
||||||
|
- **Fast initial list**: index + local cache only
|
||||||
|
- **Background enrichment**: provider info, latest version, metadata, description, readme (best effort)
|
||||||
|
- **On‑demand**: opening a repo triggers immediate enrichment; data is **persisted** to cache
|
||||||
|
- **Persistent cache**: survives HA restarts; speeds up subsequent runs
|
||||||
|
- **Refresh**: immediately rechecks installed repos and key metadata
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Restart Required
|
||||||
|
|
||||||
|
After install, update, or restore, BCS raises a **Restart required** item in Home Assistant (Repairs). You can restart directly from there.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
- **New release but no update**: Open the repo detail once; ensure it’s a **release/tag** (commits alone don’t change the ref).
|
||||||
|
- **Descriptions/Latest missing**: Wait for background enrichment or open the repo detail (forces enrichment). Cached afterwards.
|
||||||
|
(You also can Install new version by selecting in Version tab)
|
||||||
|
- **Slow startup**: BCS schedules heavy work after HA started. Keep indexes reasonable.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
- **Backups path?** `/config/.bcs_backups/<domain>/<timestamp>/`
|
||||||
|
- **Install path?** `/config/custom_components/<domain>`
|
||||||
|
- **Downgrade?** Yes, pick an older version and install.
|
||||||
|
- **Restart needed?** Yes, after install/update/restore.
|
||||||
@@ -3,35 +3,51 @@ from __future__ import annotations
|
|||||||
import logging
|
import logging
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
|
|
||||||
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.components.panel_custom import async_register_panel
|
from homeassistant.components.panel_custom import async_register_panel
|
||||||
from homeassistant.helpers.event import async_track_time_interval, async_call_later
|
from homeassistant.helpers.event import async_track_time_interval, async_call_later
|
||||||
from homeassistant.const import EVENT_HOMEASSISTANT_STARTED
|
from homeassistant.const import EVENT_HOMEASSISTANT_STARTED
|
||||||
from homeassistant.helpers.discovery import async_load_platform
|
|
||||||
|
|
||||||
from .core import BCSCore, BCSConfig, BCSError
|
from .core import BCSCore, BCSConfig, BCSError
|
||||||
|
from .config_flow import CONF_GITHUB_TOKEN
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
DOMAIN = "bahmcloud_store"
|
DOMAIN = "bahmcloud_store"
|
||||||
|
|
||||||
|
# Fixed store index URL (not configurable by users)
|
||||||
DEFAULT_STORE_URL = "https://git.bahmcloud.de/bahmcloud/ha_store/raw/branch/main/store.yaml"
|
DEFAULT_STORE_URL = "https://git.bahmcloud.de/bahmcloud/ha_store/raw/branch/main/store.yaml"
|
||||||
CONF_STORE_URL = "store_url"
|
|
||||||
|
PLATFORMS: list[str] = ["update"]
|
||||||
|
|
||||||
|
DATA_ENTRY = f"{DOMAIN}_entry_runtime"
|
||||||
|
|
||||||
|
|
||||||
async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
||||||
cfg = config.get(DOMAIN, {}) or {}
|
"""Set up Bahmcloud Store.
|
||||||
store_url = cfg.get(CONF_STORE_URL, DEFAULT_STORE_URL)
|
|
||||||
|
|
||||||
core = BCSCore(hass, BCSConfig(store_url=store_url))
|
YAML configuration is intentionally not supported.
|
||||||
|
Setup must happen via the UI (Config Flow).
|
||||||
|
"""
|
||||||
|
if DOMAIN in (config or {}):
|
||||||
|
_LOGGER.warning(
|
||||||
|
"BCS does not support configuration.yaml setup. "
|
||||||
|
"Please remove 'bahmcloud_store:' from configuration.yaml and set up the integration via Settings -> Devices & Services."
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
||||||
|
"""Set up Bahmcloud Store from a config entry."""
|
||||||
|
token = (entry.options.get(CONF_GITHUB_TOKEN) or "").strip() or None
|
||||||
|
|
||||||
|
core = BCSCore(hass, BCSConfig(store_url=DEFAULT_STORE_URL, github_token=token))
|
||||||
hass.data[DOMAIN] = core
|
hass.data[DOMAIN] = core
|
||||||
|
|
||||||
await core.async_initialize()
|
await core.async_initialize()
|
||||||
|
|
||||||
# Provide native Update entities in Settings -> System -> Updates.
|
# Register HTTP views + static assets
|
||||||
# This integration is YAML-based (async_setup), therefore we load the platform manually.
|
|
||||||
await async_load_platform(hass, "update", DOMAIN, {}, config)
|
|
||||||
|
|
||||||
from .views import (
|
from .views import (
|
||||||
StaticAssetsView,
|
StaticAssetsView,
|
||||||
BCSApiView,
|
BCSApiView,
|
||||||
@@ -62,25 +78,29 @@ async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
|||||||
hass.http.register_view(BCSRestoreView(core))
|
hass.http.register_view(BCSRestoreView(core))
|
||||||
hass.http.register_view(BCSRestartView(core))
|
hass.http.register_view(BCSRestartView(core))
|
||||||
|
|
||||||
|
# Sidebar panel
|
||||||
await async_register_panel(
|
await async_register_panel(
|
||||||
hass,
|
hass,
|
||||||
frontend_url_path="bahmcloud-store",
|
frontend_url_path="bahmcloud-store",
|
||||||
webcomponent_name="bahmcloud-store-panel",
|
webcomponent_name="bahmcloud-store-panel",
|
||||||
# IMPORTANT: bump v to avoid caching old JS
|
# IMPORTANT: bump v to avoid caching old JS
|
||||||
module_url="/api/bahmcloud_store_static/panel.js?v=108",
|
module_url="/api/bahmcloud_store_static/panel.js?v=109",
|
||||||
sidebar_title="Bahmcloud Store",
|
sidebar_title="Bahmcloud Store",
|
||||||
sidebar_icon="mdi:store",
|
sidebar_icon="mdi:store",
|
||||||
require_admin=True,
|
require_admin=True,
|
||||||
config={},
|
config={},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Forward platform setup (Update entities)
|
||||||
|
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
|
||||||
|
|
||||||
async def _do_startup_refresh(_now=None) -> None:
|
async def _do_startup_refresh(_now=None) -> None:
|
||||||
try:
|
try:
|
||||||
await core.full_refresh(source="startup")
|
await core.full_refresh(source="startup")
|
||||||
except BCSError as e:
|
except BCSError as e:
|
||||||
_LOGGER.error("Initial refresh failed: %s", e)
|
_LOGGER.error("Initial refresh failed: %s", e)
|
||||||
|
|
||||||
# Do not block Home Assistant startup. Schedule the initial refresh after HA started.
|
# Do not block HA startup: schedule refresh after HA started.
|
||||||
def _on_ha_started(_event) -> None:
|
def _on_ha_started(_event) -> None:
|
||||||
async_call_later(hass, 30, _do_startup_refresh)
|
async_call_later(hass, 30, _do_startup_refresh)
|
||||||
|
|
||||||
@@ -95,6 +115,30 @@ async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
|||||||
_LOGGER.exception("Unexpected error during periodic refresh: %s", e)
|
_LOGGER.exception("Unexpected error during periodic refresh: %s", e)
|
||||||
|
|
||||||
interval_seconds = int(getattr(core, "refresh_seconds", 300) or 300)
|
interval_seconds = int(getattr(core, "refresh_seconds", 300) or 300)
|
||||||
async_track_time_interval(hass, periodic, timedelta(seconds=interval_seconds))
|
unsub = async_track_time_interval(hass, periodic, timedelta(seconds=interval_seconds))
|
||||||
|
|
||||||
return True
|
# Store unload callbacks safely
|
||||||
|
runtimes = hass.data.setdefault(DATA_ENTRY, {})
|
||||||
|
runtimes[entry.entry_id] = {"unsub_interval": unsub}
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
||||||
|
"""Unload a config entry."""
|
||||||
|
try:
|
||||||
|
runtimes = hass.data.get(DATA_ENTRY, {}) or {}
|
||||||
|
rt = runtimes.pop(entry.entry_id, {}) if isinstance(runtimes, dict) else {}
|
||||||
|
unsub = rt.get("unsub_interval")
|
||||||
|
if callable(unsub):
|
||||||
|
unsub()
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
|
||||||
|
unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
|
||||||
|
if unload_ok:
|
||||||
|
hass.data.pop(DOMAIN, None)
|
||||||
|
return unload_ok
|
||||||
|
|
||||||
|
|
||||||
|
async def async_reload_entry(hass: HomeAssistant, entry: ConfigEntry) -> None:
|
||||||
|
await hass.config_entries.async_reload(entry.entry_id)
|
||||||
|
|||||||
87
custom_components/bahmcloud_store/config_flow.py
Normal file
87
custom_components/bahmcloud_store/config_flow.py
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import voluptuous as vol
|
||||||
|
|
||||||
|
from homeassistant import config_entries
|
||||||
|
|
||||||
|
DOMAIN = "bahmcloud_store"
|
||||||
|
|
||||||
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
CONF_GITHUB_TOKEN = "github_token"
|
||||||
|
|
||||||
|
|
||||||
|
class BCSConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
|
||||||
|
"""Config flow for Bahmcloud Store.
|
||||||
|
|
||||||
|
Design goals:
|
||||||
|
- GUI setup only (no YAML config)
|
||||||
|
- store index URL is fixed (not configurable)
|
||||||
|
- optional GitHub token to raise API rate limits
|
||||||
|
"""
|
||||||
|
|
||||||
|
VERSION = 1
|
||||||
|
|
||||||
|
async def async_step_user(self, user_input: dict[str, Any] | None = None):
|
||||||
|
"""Handle the initial step."""
|
||||||
|
# Single instance only
|
||||||
|
if self._async_current_entries():
|
||||||
|
return self.async_abort(reason="single_instance_allowed")
|
||||||
|
|
||||||
|
if user_input is not None:
|
||||||
|
token = (user_input.get(CONF_GITHUB_TOKEN) or "").strip() or None
|
||||||
|
data: dict[str, Any] = {}
|
||||||
|
options: dict[str, Any] = {}
|
||||||
|
if token:
|
||||||
|
options[CONF_GITHUB_TOKEN] = token
|
||||||
|
|
||||||
|
return self.async_create_entry(title="Bahmcloud Store", data=data, options=options)
|
||||||
|
|
||||||
|
schema = vol.Schema(
|
||||||
|
{
|
||||||
|
vol.Optional(CONF_GITHUB_TOKEN, default=""): str,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
return self.async_show_form(
|
||||||
|
step_id="user",
|
||||||
|
data_schema=schema,
|
||||||
|
description_placeholders={
|
||||||
|
"rate_limit": "GitHub API is rate-limited without a token (recommended for large indexes / HACS).",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def async_get_options_flow(config_entry: config_entries.ConfigEntry):
|
||||||
|
return BCSOptionsFlowHandler(config_entry)
|
||||||
|
|
||||||
|
|
||||||
|
class BCSOptionsFlowHandler(config_entries.OptionsFlow):
|
||||||
|
"""Handle options for Bahmcloud Store."""
|
||||||
|
|
||||||
|
def __init__(self, config_entry: config_entries.ConfigEntry) -> None:
|
||||||
|
self.config_entry = config_entry
|
||||||
|
|
||||||
|
async def async_step_init(self, user_input: dict[str, Any] | None = None):
|
||||||
|
if user_input is not None:
|
||||||
|
token = (user_input.get(CONF_GITHUB_TOKEN) or "").strip() or None
|
||||||
|
opts: dict[str, Any] = dict(self.config_entry.options)
|
||||||
|
if token:
|
||||||
|
opts[CONF_GITHUB_TOKEN] = token
|
||||||
|
else:
|
||||||
|
opts.pop(CONF_GITHUB_TOKEN, None)
|
||||||
|
return self.async_create_entry(title="", data=opts)
|
||||||
|
|
||||||
|
cur = (self.config_entry.options.get(CONF_GITHUB_TOKEN) or "").strip()
|
||||||
|
schema = vol.Schema({vol.Optional(CONF_GITHUB_TOKEN, default=cur): str})
|
||||||
|
|
||||||
|
return self.async_show_form(
|
||||||
|
step_id="init",
|
||||||
|
data_schema=schema,
|
||||||
|
description_placeholders={
|
||||||
|
"rate_limit": "Optional. Adds GitHub authorization to avoid rate limits.",
|
||||||
|
},
|
||||||
|
)
|
||||||
@@ -42,6 +42,9 @@ HACS_CACHE_TTL_SECONDS = 60 * 60 * 24 # 24h
|
|||||||
# - persists across restarts
|
# - persists across restarts
|
||||||
# - keeps UI populated (name/description/latest) without blocking startup
|
# - keeps UI populated (name/description/latest) without blocking startup
|
||||||
REPO_CACHE_TTL_SECONDS = 6 * 60 * 60 # 6h
|
REPO_CACHE_TTL_SECONDS = 6 * 60 * 60 # 6h
|
||||||
|
# Release/tag lists change rarely and can be expensive for some providers (e.g. GitHub rate limits).
|
||||||
|
# Cache them longer and refresh only on-demand (when the user opens the version selector).
|
||||||
|
VERSIONS_CACHE_TTL_SECONDS = 7 * 24 * 60 * 60 # 7d
|
||||||
|
|
||||||
|
|
||||||
class BCSError(Exception):
|
class BCSError(Exception):
|
||||||
@@ -55,6 +58,7 @@ class BCSInstallError(BCSError):
|
|||||||
@dataclass
|
@dataclass
|
||||||
class BCSConfig:
|
class BCSConfig:
|
||||||
store_url: str
|
store_url: str
|
||||||
|
github_token: str | None = None
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
@@ -572,6 +576,12 @@ class BCSCore:
|
|||||||
if isinstance(cached, dict):
|
if isinstance(cached, dict):
|
||||||
ts = int(cached.get("ts") or 0)
|
ts = int(cached.get("ts") or 0)
|
||||||
|
|
||||||
|
# Background enrichment should be a one-time best-effort pass.
|
||||||
|
# If we already attempted it once for this repo, do not keep retrying on every refresh.
|
||||||
|
# On-demand (opening repo details / version selector) can still refresh and persist.
|
||||||
|
if bool(cached.get("bg_done")):
|
||||||
|
return False
|
||||||
|
|
||||||
# Missing key fields -> enrich.
|
# Missing key fields -> enrich.
|
||||||
if not r.latest_version:
|
if not r.latest_version:
|
||||||
return True
|
return True
|
||||||
@@ -634,10 +644,20 @@ class BCSCore:
|
|||||||
await self._enrich_one_repo(r)
|
await self._enrich_one_repo(r)
|
||||||
except Exception:
|
except Exception:
|
||||||
_LOGGER.debug("BCS background enrich failed for %s", repo_id, exc_info=True)
|
_LOGGER.debug("BCS background enrich failed for %s", repo_id, exc_info=True)
|
||||||
|
# Mark as attempted so we don't keep hammering the provider.
|
||||||
|
async with self._repo_cache_lock:
|
||||||
|
cached = self._repo_cache.setdefault(str(repo_id), {})
|
||||||
|
if isinstance(cached, dict):
|
||||||
|
cached["bg_done"] = True
|
||||||
|
cached["bg_done_ts"] = int(time.time())
|
||||||
return
|
return
|
||||||
|
|
||||||
async with self._repo_cache_lock:
|
async with self._repo_cache_lock:
|
||||||
self._update_repo_cache_from_repo(repo_id, r)
|
self._update_repo_cache_from_repo(repo_id, r)
|
||||||
|
cached = self._repo_cache.setdefault(str(repo_id), {})
|
||||||
|
if isinstance(cached, dict):
|
||||||
|
cached["bg_done"] = True
|
||||||
|
cached["bg_done_ts"] = int(time.time())
|
||||||
updated += 1
|
updated += 1
|
||||||
|
|
||||||
# Process sequentially but allow limited concurrency.
|
# Process sequentially but allow limited concurrency.
|
||||||
@@ -677,7 +697,11 @@ class BCSCore:
|
|||||||
|
|
||||||
async def process_one(r: RepoItem) -> None:
|
async def process_one(r: RepoItem) -> None:
|
||||||
async with sem:
|
async with sem:
|
||||||
info: RepoInfo = await fetch_repo_info(self.hass, r.url)
|
info: RepoInfo = await fetch_repo_info(
|
||||||
|
self.hass,
|
||||||
|
r.url,
|
||||||
|
github_token=self.config.github_token,
|
||||||
|
)
|
||||||
|
|
||||||
r.provider = info.provider or r.provider
|
r.provider = info.provider or r.provider
|
||||||
r.owner = info.owner or r.owner
|
r.owner = info.owner or r.owner
|
||||||
@@ -736,7 +760,11 @@ class BCSCore:
|
|||||||
|
|
||||||
async def _enrich_one_repo(self, r: RepoItem) -> None:
|
async def _enrich_one_repo(self, r: RepoItem) -> None:
|
||||||
"""Fetch provider info + metadata for a single repo item."""
|
"""Fetch provider info + metadata for a single repo item."""
|
||||||
info: RepoInfo = await fetch_repo_info(self.hass, r.url)
|
info: RepoInfo = await fetch_repo_info(
|
||||||
|
self.hass,
|
||||||
|
r.url,
|
||||||
|
github_token=self.config.github_token,
|
||||||
|
)
|
||||||
|
|
||||||
r.provider = info.provider or r.provider
|
r.provider = info.provider or r.provider
|
||||||
r.owner = info.owner or r.owner
|
r.owner = info.owner or r.owner
|
||||||
@@ -788,11 +816,54 @@ class BCSCore:
|
|||||||
_LOGGER.debug("BCS ensure_repo_details failed for %s", repo_id, exc_info=True)
|
_LOGGER.debug("BCS ensure_repo_details failed for %s", repo_id, exc_info=True)
|
||||||
return r
|
return r
|
||||||
|
|
||||||
async def list_repo_versions(self, repo_id: str) -> list[dict[str, Any]]:
|
async def list_repo_versions(self, repo_id: str, *, limit: int = 20) -> list[dict[str, str]]:
|
||||||
repo = self.get_repo(repo_id)
|
repo = self.get_repo(repo_id)
|
||||||
if not repo:
|
if not repo:
|
||||||
return []
|
return []
|
||||||
return await fetch_repo_versions(self.hass, repo.url)
|
|
||||||
|
# Prefer cached version lists to avoid hammering provider APIs (notably GitHub unauthenticated
|
||||||
|
# rate limits). We refresh on-demand when the user opens the selector.
|
||||||
|
cached = None
|
||||||
|
cached_ts = 0
|
||||||
|
async with self._repo_cache_lock:
|
||||||
|
cached = self._repo_cache.get(str(repo_id)) if isinstance(self._repo_cache, dict) else None
|
||||||
|
if isinstance(cached, dict):
|
||||||
|
cached_ts = int(cached.get("versions_ts", 0) or 0)
|
||||||
|
|
||||||
|
now = int(time.time())
|
||||||
|
if isinstance(cached, dict) and cached.get("versions") and (now - cached_ts) < VERSIONS_CACHE_TTL_SECONDS:
|
||||||
|
return list(cached.get("versions") or [])
|
||||||
|
|
||||||
|
try:
|
||||||
|
versions = await fetch_repo_versions(
|
||||||
|
self.hass,
|
||||||
|
repo.url,
|
||||||
|
provider=repo.provider,
|
||||||
|
default_branch=repo.default_branch,
|
||||||
|
github_token=self.config.github_token,
|
||||||
|
limit=limit,
|
||||||
|
)
|
||||||
|
except Exception:
|
||||||
|
versions = []
|
||||||
|
|
||||||
|
# If the provider fetch returned only the basic fallbacks ("Latest" + "Branch") but we have
|
||||||
|
# a previously cached richer list, keep using the cached list.
|
||||||
|
if (
|
||||||
|
isinstance(cached, dict)
|
||||||
|
and cached.get("versions")
|
||||||
|
and len(list(cached.get("versions") or [])) > 2
|
||||||
|
and len(versions) <= 2
|
||||||
|
):
|
||||||
|
return list(cached.get("versions") or [])
|
||||||
|
|
||||||
|
# Persist whatever we got (even if small) to avoid repeated calls when rate-limited.
|
||||||
|
async with self._repo_cache_lock:
|
||||||
|
entry = self._repo_cache.setdefault(str(repo_id), {}) if isinstance(self._repo_cache, dict) else {}
|
||||||
|
if isinstance(entry, dict):
|
||||||
|
entry["versions"] = versions
|
||||||
|
entry["versions_ts"] = now
|
||||||
|
await self._persist_repo_cache()
|
||||||
|
return versions
|
||||||
|
|
||||||
def _add_cache_buster(self, url: str) -> str:
|
def _add_cache_buster(self, url: str) -> str:
|
||||||
parts = urlsplit(url)
|
parts = urlsplit(url)
|
||||||
@@ -972,23 +1043,6 @@ class BCSCore:
|
|||||||
default_branch=repo.default_branch,
|
default_branch=repo.default_branch,
|
||||||
)
|
)
|
||||||
|
|
||||||
async def list_repo_versions(self, repo_id: str, *, limit: int = 20) -> list[dict[str, str]]:
|
|
||||||
"""List installable versions/refs for a repo.
|
|
||||||
|
|
||||||
This is used by the UI to allow selecting an older tag/release.
|
|
||||||
"""
|
|
||||||
repo = self.get_repo(repo_id)
|
|
||||||
if not repo:
|
|
||||||
raise BCSInstallError(f"repo_id not found: {repo_id}")
|
|
||||||
|
|
||||||
return await fetch_repo_versions(
|
|
||||||
self.hass,
|
|
||||||
repo.url,
|
|
||||||
provider=repo.provider,
|
|
||||||
default_branch=repo.default_branch,
|
|
||||||
limit=limit,
|
|
||||||
)
|
|
||||||
|
|
||||||
def _pick_ref_for_install(self, repo: RepoItem) -> str:
|
def _pick_ref_for_install(self, repo: RepoItem) -> str:
|
||||||
if repo.latest_version and str(repo.latest_version).strip():
|
if repo.latest_version and str(repo.latest_version).strip():
|
||||||
return str(repo.latest_version).strip()
|
return str(repo.latest_version).strip()
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"domain": "bahmcloud_store",
|
"domain": "bahmcloud_store",
|
||||||
"name": "Bahmcloud Store",
|
"name": "Bahmcloud Store",
|
||||||
"version": "0.6.7",
|
"version": "0.6.9",
|
||||||
"documentation": "https://git.bahmcloud.de/bahmcloud/bahmcloud_store",
|
"documentation": "https://git.bahmcloud.de/bahmcloud/bahmcloud_store",
|
||||||
"platforms": ["update"],
|
"platforms": ["update"],
|
||||||
"requirements": [],
|
"requirements": [],
|
||||||
|
|||||||
@@ -16,6 +16,17 @@ _LOGGER = logging.getLogger(__name__)
|
|||||||
UA = "BahmcloudStore (Home Assistant)"
|
UA = "BahmcloudStore (Home Assistant)"
|
||||||
|
|
||||||
|
|
||||||
|
def _github_headers(github_token: str | None = None) -> dict[str, str]:
|
||||||
|
headers = {
|
||||||
|
"Accept": "application/vnd.github+json",
|
||||||
|
"User-Agent": UA,
|
||||||
|
}
|
||||||
|
token = (github_token or "").strip()
|
||||||
|
if token:
|
||||||
|
headers["Authorization"] = f"Bearer {token}"
|
||||||
|
return headers
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
class RepoInfo:
|
class RepoInfo:
|
||||||
owner: str | None = None
|
owner: str | None = None
|
||||||
@@ -189,9 +200,11 @@ async def _github_latest_version_redirect(hass: HomeAssistant, owner: str, repo:
|
|||||||
return None, None
|
return None, None
|
||||||
|
|
||||||
|
|
||||||
async def _github_latest_version_api(hass: HomeAssistant, owner: str, repo: str) -> tuple[str | None, str | None]:
|
async def _github_latest_version_api(
|
||||||
|
hass: HomeAssistant, owner: str, repo: str, *, github_token: str | None = None
|
||||||
|
) -> tuple[str | None, str | None]:
|
||||||
session = async_get_clientsession(hass)
|
session = async_get_clientsession(hass)
|
||||||
headers = {"Accept": "application/vnd.github+json", "User-Agent": UA}
|
headers = _github_headers(github_token)
|
||||||
|
|
||||||
data, status = await _safe_json(session, f"https://api.github.com/repos/{owner}/{repo}/releases/latest", headers=headers)
|
data, status = await _safe_json(session, f"https://api.github.com/repos/{owner}/{repo}/releases/latest", headers=headers)
|
||||||
if isinstance(data, dict) and data.get("tag_name"):
|
if isinstance(data, dict) and data.get("tag_name"):
|
||||||
@@ -217,12 +230,14 @@ async def _github_latest_version_api(hass: HomeAssistant, owner: str, repo: str)
|
|||||||
return None, None
|
return None, None
|
||||||
|
|
||||||
|
|
||||||
async def _github_latest_version(hass: HomeAssistant, owner: str, repo: str) -> tuple[str | None, str | None]:
|
async def _github_latest_version(
|
||||||
|
hass: HomeAssistant, owner: str, repo: str, *, github_token: str | None = None
|
||||||
|
) -> tuple[str | None, str | None]:
|
||||||
tag, src = await _github_latest_version_redirect(hass, owner, repo)
|
tag, src = await _github_latest_version_redirect(hass, owner, repo)
|
||||||
if tag:
|
if tag:
|
||||||
return tag, src
|
return tag, src
|
||||||
|
|
||||||
tag, src = await _github_latest_version_api(hass, owner, repo)
|
tag, src = await _github_latest_version_api(hass, owner, repo, github_token=github_token)
|
||||||
if tag:
|
if tag:
|
||||||
return tag, src
|
return tag, src
|
||||||
|
|
||||||
@@ -316,7 +331,7 @@ async def _gitlab_latest_version(
|
|||||||
return None, None
|
return None, None
|
||||||
|
|
||||||
|
|
||||||
async def fetch_repo_info(hass: HomeAssistant, repo_url: str) -> RepoInfo:
|
async def fetch_repo_info(hass: HomeAssistant, repo_url: str, *, github_token: str | None = None) -> RepoInfo:
|
||||||
provider = detect_provider(repo_url)
|
provider = detect_provider(repo_url)
|
||||||
owner, repo = _split_owner_repo(repo_url)
|
owner, repo = _split_owner_repo(repo_url)
|
||||||
|
|
||||||
@@ -337,7 +352,7 @@ async def fetch_repo_info(hass: HomeAssistant, repo_url: str) -> RepoInfo:
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
if provider == "github":
|
if provider == "github":
|
||||||
headers = {"Accept": "application/vnd.github+json", "User-Agent": UA}
|
headers = _github_headers(github_token)
|
||||||
data, status = await _safe_json(session, f"https://api.github.com/repos/{owner}/{repo}", headers=headers)
|
data, status = await _safe_json(session, f"https://api.github.com/repos/{owner}/{repo}", headers=headers)
|
||||||
|
|
||||||
if isinstance(data, dict):
|
if isinstance(data, dict):
|
||||||
@@ -356,7 +371,7 @@ async def fetch_repo_info(hass: HomeAssistant, repo_url: str) -> RepoInfo:
|
|||||||
if desc:
|
if desc:
|
||||||
info.description = desc
|
info.description = desc
|
||||||
|
|
||||||
ver, src = await _github_latest_version(hass, owner, repo)
|
ver, src = await _github_latest_version(hass, owner, repo, github_token=github_token)
|
||||||
info.latest_version = ver
|
info.latest_version = ver
|
||||||
info.latest_version_source = src
|
info.latest_version_source = src
|
||||||
return info
|
return info
|
||||||
@@ -514,6 +529,7 @@ async def fetch_repo_versions(
|
|||||||
provider: str | None = None,
|
provider: str | None = None,
|
||||||
default_branch: str | None = None,
|
default_branch: str | None = None,
|
||||||
limit: int = 20,
|
limit: int = 20,
|
||||||
|
github_token: str | None = None,
|
||||||
) -> list[dict[str, str]]:
|
) -> list[dict[str, str]]:
|
||||||
"""List available versions/refs for a repository.
|
"""List available versions/refs for a repository.
|
||||||
|
|
||||||
@@ -560,7 +576,7 @@ async def fetch_repo_versions(
|
|||||||
try:
|
try:
|
||||||
if prov == "github":
|
if prov == "github":
|
||||||
# Releases
|
# Releases
|
||||||
gh_headers = {"Accept": "application/vnd.github+json", "User-Agent": UA}
|
gh_headers = _github_headers(github_token)
|
||||||
data, _ = await _safe_json(
|
data, _ = await _safe_json(
|
||||||
session,
|
session,
|
||||||
f"https://api.github.com/repos/{owner}/{repo}/releases?per_page={int(limit)}",
|
f"https://api.github.com/repos/{owner}/{repo}/releases?per_page={int(limit)}",
|
||||||
|
|||||||
@@ -1,4 +1,29 @@
|
|||||||
{
|
{
|
||||||
|
"config": {
|
||||||
|
"abort": {
|
||||||
|
"single_instance_allowed": "Bahmcloud Store is already configured."
|
||||||
|
},
|
||||||
|
"step": {
|
||||||
|
"user": {
|
||||||
|
"title": "Set up Bahmcloud Store",
|
||||||
|
"description": "The store index is fixed to the official Bahmcloud Store.\n\nOptional: Add a GitHub token to increase API rate limits for GitHub/HACS repositories.",
|
||||||
|
"data": {
|
||||||
|
"github_token": "GitHub token (optional)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"options": {
|
||||||
|
"step": {
|
||||||
|
"init": {
|
||||||
|
"title": "Bahmcloud Store options",
|
||||||
|
"description": "Optional: Configure a GitHub token to increase API rate limits.",
|
||||||
|
"data": {
|
||||||
|
"github_token": "GitHub token (optional)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"issues": {
|
"issues": {
|
||||||
"restart_required": {
|
"restart_required": {
|
||||||
"title": "Restart required",
|
"title": "Restart required",
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ from dataclasses import dataclass
|
|||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from homeassistant.components.update import UpdateEntity, UpdateEntityFeature
|
from homeassistant.components.update import UpdateEntity, UpdateEntityFeature
|
||||||
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.core import HomeAssistant, callback
|
from homeassistant.core import HomeAssistant, callback
|
||||||
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
||||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
@@ -139,13 +140,8 @@ def _sync_entities(core: BCSCore, existing: dict[str, BCSRepoUpdateEntity], asyn
|
|||||||
ent.async_write_ha_state()
|
ent.async_write_ha_state()
|
||||||
|
|
||||||
|
|
||||||
async def async_setup_platform(
|
async def _async_setup(hass: HomeAssistant, async_add_entities: AddEntitiesCallback) -> None:
|
||||||
hass: HomeAssistant,
|
"""Common update entity setup for both config entries and legacy YAML."""
|
||||||
config,
|
|
||||||
async_add_entities: AddEntitiesCallback,
|
|
||||||
discovery_info=None,
|
|
||||||
):
|
|
||||||
"""Set up BCS update entities."""
|
|
||||||
core: BCSCore | None = hass.data.get(DOMAIN)
|
core: BCSCore | None = hass.data.get(DOMAIN)
|
||||||
if not core:
|
if not core:
|
||||||
_LOGGER.debug("BCS core not available, skipping update platform setup")
|
_LOGGER.debug("BCS core not available, skipping update platform setup")
|
||||||
@@ -159,4 +155,23 @@ async def async_setup_platform(
|
|||||||
def _handle_update() -> None:
|
def _handle_update() -> None:
|
||||||
_sync_entities(core, entities, async_add_entities)
|
_sync_entities(core, entities, async_add_entities)
|
||||||
|
|
||||||
async_dispatcher_connect(hass, SIGNAL_UPDATED, _handle_update)
|
async_dispatcher_connect(hass, SIGNAL_UPDATED, _handle_update)
|
||||||
|
|
||||||
|
|
||||||
|
async def async_setup_entry(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
entry: ConfigEntry,
|
||||||
|
async_add_entities: AddEntitiesCallback,
|
||||||
|
) -> None:
|
||||||
|
"""Set up update entities from a config entry."""
|
||||||
|
await _async_setup(hass, async_add_entities)
|
||||||
|
|
||||||
|
|
||||||
|
async def async_setup_platform(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
config,
|
||||||
|
async_add_entities: AddEntitiesCallback,
|
||||||
|
discovery_info=None,
|
||||||
|
):
|
||||||
|
"""Legacy YAML setup (not supported, kept for safety)."""
|
||||||
|
await _async_setup(hass, async_add_entities)
|
||||||
Reference in New Issue
Block a user