ha-websocket-api

Creates custom WebSocket API commands for Home Assistant integrations with voluptuous validation.

6|1|Updated Feb 16, 2026
One-click install
npx skills add https://github.com/L3DigitalNet/Claude-Code-Plugins --skill ha-websocket-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ha-websocket-api
Source: https://github.com/L3DigitalNet/Claude-Code-Plugins/tree/main/plugins/home-assistant-dev/skills/ha-websocket-api
Command: npx skills add https://github.com/L3DigitalNet/Claude-Code-Plugins --skill ha-websocket-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill enables the creation of custom WebSocket API endpoints for Home Assistant integrations, facilitating real-time data exchange between the frontend and backend.

Core Features & Use Cases

  • Custom API Endpoints: Define and register unique WebSocket commands for specific integration needs.
  • Real-time Data Streaming: Push live updates from Home Assistant to custom frontend panels or external tools.
  • Use Case: Develop a custom dashboard card for Home Assistant that displays live sensor readings and allows users to control devices through a dedicated WebSocket connection.

Quick Start

Use the ha-websocket-api skill to register a new WebSocket command for fetching device lists.

Frequently Asked Questions about ha-websocket-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a custom WebSocket API endpoint for a Home Assistant integration?▼

To create a custom WebSocket API endpoint for a Home Assistant integration, you register unique commands using the `websocket_api` module and validate input data with `voluptuous` to enable real-time frontend-backend data exchange.

What is the best way to stream real-time data to a Home Assistant custom dashboard card?▼

Streaming real-time data to a Home Assistant custom dashboard card is achieved by implementing custom WebSocket API commands that push live updates directly from the backend to the frontend panel over a dedicated connection.

Does Home Assistant WebSocket API integration require voluptuous for command registration?▼

Yes, Home Assistant WebSocket API integration requires the `voluptuous` library for input validation and command registration to ensure data integrity when defining custom endpoints for dynamic third-party communication.

Can I use custom WebSocket commands to integrate third-party tools with Home Assistant?▼

You can use custom WebSocket commands to integrate third-party tools with Home Assistant by establishing dynamic communication channels that facilitate real-time data streaming and custom interactions between external systems and the backend.

When should I use the WebSocket API instead of standard REST APIs in Home Assistant frontend development?▼

You should use the WebSocket API instead of standard REST APIs in Home Assistant frontend development when building advanced panels that require continuous real-time data flow, live sensor readings, and instant device control without polling overhead.