The Watchman
A Home Assistant custom integration that scans configuration files for missing or renamed entities and actions to prevent automation failures.
What is The Watchman?
The Watchman is a Home Assistant custom integration that scans your YAML configuration files to find references to missing, unavailable, or renamed entities and services. It helps prevent automation failures by alerting you to configuration issues before they cause problems, ensuring your smart home setup remains reliable as it evolves.
Home Assistant users with complex configurations involving automations, scripts, dashboards, and templates who need to maintain system reliability and avoid broken references.
Developers choose The Watchman for its proactive approach to configuration validation, lightweight parsing, and detailed reporting that integrates seamlessly with Home Assistant's ecosystem, offering a specialized tool not natively available in the platform.
Overview
Home Assistant custom integration to keep track of missing entities and actions in your config files
Use Cases
Best For
- Detecting missing entities after removing or renaming integrations
- Validating service and action references in automations and scripts
- Monitoring configuration health in large Home Assistant setups
- Preventing automation failures due to unavailable entities
- Auditing YAML configuration files for broken references
- Integrating configuration validation into dashboards via diagnostic sensors
Not Ideal For
- Home Assistant users who exclusively configure via the UI without YAML files
- Projects requiring flawless, dependency-aware validation without any manual rule tuning
- Setups with performance constraints where scanning large YAML files on every change is not feasible
Pros & Cons
Pros
Scans YAML configuration files to identify missing or renamed entities and services before they cause automation failures, as emphasized in its lightweight philosophy to maintain robust setups.
Supports wildcard patterns for ignoring entities, actions, files, and folders, with detailed examples in the configuration options to reduce false positives and tailor scanning.
Provides real-time sensors like watchman_missing_entities for dashboard integration, enabling continuous monitoring of configuration health without manual checks.
Generates reports as text files, YAML responses, or sends notifications via actions with configurable parameters like chunk_size, as shown in the action examples for compatibility with various services.
Cons
Relies on regex-based heuristics that can produce both false positives and negatives, necessitating manual adjustment of ignore rules, as admitted in the README under 'What does it do'.
Requires fine-tuning multiple options like startup delays, ignore lists, and file exclusions, which can be complex and time-consuming for users with large or dynamic configurations.
Only scans YAML files, so references in non-YAML sources or dynamically generated content may be overlooked, limiting comprehensiveness in mixed configuration environments.
Frequently Asked Questions
Related Projects
Sonoff LANControl Sonoff Devices with eWeLink (original) firmware over LAN and/or Cloud from Home Assistant
WebRTC CameraHome Assistant custom component for real-time viewing of almost any camera stream using WebRTC and other technologies.
Xiaomi Cloud Map ExtractorThis custom integration provides a way to present a live view of a map for Xiaomi (Roborock/Viomi/Roidmi/Dreame) vacuums without a need for rooting.
Circadian LightingCircadian Lighting custom component for Home Assistant
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.