ha-integration-patterns
Home Assistant custom integration patterns and architectural decisions. Use when building HACS integrations, custom components, or API bridges for Home Assistant. Covers service response data, HTTP views, storage APIs, and integration architecture.
Why use this skill?
Master Home Assistant integration architecture. Learn standard patterns for custom services, HTTP views, and data storage to build stable, future-proof HACS components.
Install via CLI (Recommended)
clawhub install openclaw/skills/skills/usimic/ha-integration-patternsWhat This Skill Does
This skill provides comprehensive architectural guidance for building Home Assistant custom integrations. It serves as a technical reference for developers creating HACS components, custom entities, or API bridges. It focuses on the latest best practices for service response data, HTTP view implementation, and secure data storage using the HA framework's public APIs. The skill helps you avoid common pitfalls, such as using private underscore-prefixed methods, and ensures your integrations remain compatible across Home Assistant version updates.
Installation
To install this skill, use the following command in your ClawHub-enabled environment:
clawhub install openclaw/skills/skills/usimic/ha-integration-patterns
Use Cases
- Service Responses: Implementing services that return data directly to callers rather than being "fire-and-forget."
- API Views: Building custom HTTP endpoints for frontend dashboards or mobile app integrations.
- Storage Management: Safely persisting small configuration settings or caches without violating HA core standards.
- Refactoring: Updating legacy integrations to handle breaking changes like the 2023.7 service response patterns or migration of config entries.
- Architecture Review: Determining when to expose functionality via a service vs. a custom HTTP view.
Example Prompts
- "How do I register a Home Assistant service that returns the current entity configuration instead of just performing an action?"
- "Can you provide a code template for a custom HTTP view that requires authentication and serves JSON data from my integration?"
- "What is the recommended way to store integration-specific configuration data to ensure it persists after a reboot, and how do I avoid using internal storage collections?"
Tips & Limitations
- Public API Priority: Always prioritize public methods (e.g.,
helpers.storage.Store) over internalhass.datakeys to ensure your integration survives core version updates. - Breaking Changes: Keep an eye on the official Home Assistant release blog when targeting specific version ranges, as internal patterns evolve frequently.
- Performance: This skill is intended for lightweight configuration and state management. For large datasets or high-frequency logging, do not use HA storage helpers; rely on external database solutions instead to prevent impacting Home Assistant's core performance.
Metadata
Not sure this is the right skill?
Describe what you want to build — we'll match you to the best skill from 16,000+ options.
Find the right skillPaste this into your clawhub.json to enable this plugin.
{
"plugins": {
"official-usimic-ha-integration-patterns": {
"enabled": true,
"auto_update": true
}
}
}Tags(AI)
Flags: code-execution, file-read, file-write