Skip to content

Commit ce083dd

Browse files
author
Franz646
committed
docs: update README with default ignore list and glob support
1 parent fa2b357 commit ce083dd

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,26 @@ After installation, the **Orphan Cleaner** icon appears in the HA sidebar. All s
3838
| **Scan** | Scans the registry and populates the table |
3939
| **Heuristic** | Enables detection method 4 (see below) |
4040
| **Min age (h)** | Minimum age in hours for an entity to be flagged |
41-
| **Ignore platforms** | Add platform names to exclude from results (e.g. `tuya`, `shelly`) |
41+
| **Ignore** | Add platforms or globs to exclude from the current session |
42+
| **Default ignore list** | Persistent ignore list, pre-loaded on every scan (see below) |
4243
| **Filter** | Filter visible results by entity_id or platform |
4344
| **Select all / Deselect** | Bulk checkbox controls |
4445
| **Delete selected** | Delete selected entities with a confirmation dialog |
4546
| **Save & Delete** | Save a JSON backup of selected entities to `/config/` before deleting |
4647

47-
### Ignore Platforms
48+
### Ignore (session)
4849

49-
Type a platform name in the **Ignore platforms** field and press **Enter** or **+ Add**. The platform appears as a removable pill tag. Ignored entities remain visible in the table but are greyed out and non-interactive. The orphan counter reflects the exclusion. The ignore list is applied immediately and persists across rescans during the same session.
50+
Type a platform name or glob pattern in the **Ignore** field in the control bar and press **Enter** or **+ Add**. Ignored entities remain visible in the table but are greyed out and non-interactive. The orphan counter reflects the exclusion. This list is temporary and resets on page reload.
51+
52+
### Default ignore list (persistent)
53+
54+
A collapsible section below the control bar. Entries here are saved to the integration's config entry options and automatically loaded on every scan and page load. Supports:
55+
56+
- **Platform names**`tuya`, `shelly`, `imou_life`
57+
- **Platform globs**`imou_*`, `tuya_*`
58+
- **Entity ID globs**`sensor.old_*`, `*_deprecated`, `sensor.*_temp`
59+
60+
Press **💾 Save** to persist the current list. Use the **?** link for a full syntax reference.
5061

5162
### Save & Delete
5263

@@ -152,7 +163,7 @@ custom_components/orphan_cleaner/
152163
├── const.py ← constants
153164
├── manifest.json ← integration metadata
154165
├── orphan_detector.py ← detection and deletion logic
155-
├── panel_api.py ← HTTP views (panel, scan, delete, export)
166+
├── panel_api.py ← HTTP views (panel, scan, delete, export, ignore list)
156167
├── services.py ← HA services (scan, delete_orphans)
157168
├── services.yaml ← service documentation for Developer Tools
158169
├── strings.json ← UI labels

0 commit comments

Comments
 (0)