Home Assistant WS icon

Home Assistant WS

Node to interact with Home Assistant through the WebSocket API
Join our community

Actions7

Overview

This node enables interaction with Home Assistant via its WebSocket API. It supports multiple resources such as Area, Category, Device, Entity, Logbook, Service Action, and State, allowing users to perform various operations on these resources.

For the Category resource with the List operation, the node retrieves a list of categories from Home Assistant. This is useful for scenarios where you want to fetch and process category data dynamically within your automation workflows, such as displaying available categories or filtering entities by category.

Example use cases:

  • Listing all categories to populate a dropdown in subsequent workflow steps.
  • Fetching categories to monitor or trigger automations based on category changes.

Properties

Name Meaning
Category Scope A string input that likely filters or scopes the categories to be listed (exact usage depends on implementation).

Output

The node outputs an array of JSON objects representing the categories retrieved from Home Assistant. Each object corresponds to a category with its associated properties as provided by the Home Assistant API.

If binary data were involved, it would typically represent media or files related to the categories, but this node focuses on JSON data output only.

Dependencies

  • Requires connection to a Home Assistant instance via its WebSocket API.
  • Needs an API key credential for authentication with Home Assistant.
  • The node depends on internal modules handling specific operations per resource, including CategoryOperations for category-related actions.

Troubleshooting

  • Connection issues: Ensure the Home Assistant host URL and API key are correctly configured and accessible.
  • Empty results: Verify that the "Category Scope" property is set correctly; an incorrect or empty scope might result in no categories being returned.
  • Authentication errors: Confirm that the API key has sufficient permissions to access category data.
  • Timeouts or disconnections: Network instability or Home Assistant server issues can cause failures; check connectivity and server status.

Links and References

Discussion