🏠 Home Assistant Plugin

For StreamController

Control your Home Assistant instance directly from your StreamDeck

Features • Installation • Documentation • Examples • Support

---

This is not an official plugin - I have no affiliation with Home Assistant, StreamDeck, or StreamController.

📋 Table of Contents

• Prerequisites
• Features
• Installation
• Documentation
  • Plugin Settings
  • Perform Action
  • Show Icon
  • Show Text
• Examples
• Support

✅ Prerequisites

Before using this plugin, ensure the following requirements are met:

• WebSocket API: The websocket_api component must be present in your configuration.yaml

  • Remember to restart Home Assistant after updating your configuration

• Long-Lived Access Token: Required to authenticate with Home Assistant

  1. Navigate to your user profile in Home Assistant
  2. Click on the Security tab
  3. Scroll to the bottom and create a new Long-Lived Access Token
  4. Copy the token immediately - you won't be able to retrieve it later!

Security Notice: Keep your Home Assistant URL and access token secure. Anyone with this information can access and control your Home Assistant instance if it's exposed to the internet.

✨ Features

🎬 Perform an Action

• Execute any Home Assistant action/service
• Provide custom parameters for actions
• Actions trigger on key_down (button press) by default
• Use the built-in Event Assigner to customize behavior:
  • Map different events to key_down
  • Disable key_down by mapping it to None

🎨 Show an Icon

• Display entity icons or custom icons from Material Design Icons
• Customize icon appearance:
  • 🎨 Color
  • 📏 Scale
  • 🌫️ Opacity
• Dynamic customization based on state or attribute values
• Automatic updates when entity state changes

📝 Show Text

• Display entity state, attributes, or custom text
• Real-time updates when entity state changes
• Full customization options:
  • 📍 Position
  • 📐 Text size
  • 🎨 Text color
  • 🔲 Outline size and color
• Show unit of measurement (with optional line breaks)
• Dynamic customization based on state or attribute values

📥 Installation

1. Install the plugin through StreamController's plugin manager
2. Configure your Home Assistant connection in the plugin settings
3. Start adding actions to your StreamDeck buttons!

📖 Documentation

⚙️ Plugin Settings

Opening the Settings:

1. Open your StreamController settings
2. Navigate to the Plugins tab
3. Find Home Assistant in the list
4. Click Open Settings

Configuration:

• Enter your Home Assistant URL
• Provide your long-lived access token
• For self-signed certificates, disable Verify certificate

The plugin automatically attempts to connect once all information is entered. If the connection fails or is lost, it will retry every 10 seconds.

---

🎬 Perform Action

Execute Home Assistant actions directly from your StreamDeck.

Configuration:

• Action: Select the Home Assistant action to perform
• Entity (optional): Choose the target entity if required
• Parameters (optional): Configure action parameters
  • Only checked parameters are sent with the action
  • List shows all possible parameters (not all may be supported by the entity)

---

🎨 Show Icon

Display dynamic icons based on Home Assistant entity data.

Configuration:

• Entity: Select the Home Assistant entity
• Icon:
  • Leave empty to use the entity's default icon
  • Enter a Material Design Icon name to override
• Customization: Adjust color, scale, and opacity

🎯 Icon Customization

Create conditional icon appearances based on entity states.

Creating a Customization:

1. Click the button in the Customize row
2. Define a condition (state or attribute value)
3. Configure icon changes when the condition is met

Managing Customizations:

Cascading Behavior: Customizations are evaluated in order from top to bottom. When multiple conditions match, the last matching customization wins. In the example above, both conditions are met, but the icon displayed is lamp from the second customization.

Features:

• ✏️ Edit, delete, and reorder customizations
• 👁️ View current entity value for reference
• ✅ Only checked settings are applied

---

📝 Show Text

Display dynamic text based on Home Assistant entity data.

Configuration:

• Entity: Select the Home Assistant entity
• Position: Choose where the text appears on the key
• Attribute: Select what to display:
  • Entity state
  • Specific attribute value
• Rounding:
  • Enable to round numeric values
  • Set decimal precision
• Styling:
  • Text size and color
  • Outline size and color
• Unit of Measurement (if available):
  • Show/hide unit
  • Optional line break between value and unit

🎯 Text Customization

Create conditional text appearances based on entity states.

Creating a Customization:

1. Click the button in the Customize row
2. Define a condition (state or attribute value)
3. Configure text changes when the condition is met

Managing Customizations:

Cascading Behavior: Like icon customizations, text customizations are evaluated in order. The last matching customization sets the final value. In the example above, only the second customization matches, setting text size to 12.

Advanced Features:

• Custom Text: Select custom_text as an attribute to display custom messages
  • Use %s as a placeholder for the original value
  • Use \n for line breaks
  • Example: For a temperature attribute, use %s\n°C to display:

    23.5
    °C
    

  • Perfect for creating custom translations!

Features:

• ✏️ Edit, delete, and reorder customizations
• 👁️ View current entity value for reference
• ✅ Only checked settings are applied

---

🎯 Examples

🌤️ Weather Display

Setup:

• Uses Show Text action with a weather entity
• Displays current weather information directly on your StreamDeck

---

🔘 Toggle Button

Setup:

• Show Icon: Display icon with customization
  • Changes color to yellow when input_boolean is on
• Perform Action: Toggle the input_boolean state
• Both actions use the same entity

---

🎵 Media Player Control

Setup:

• Show Icon: Dynamic play/pause icon
  • Shows play icon by default
  • Shows pause icon when media is playing
• Perform Action: Execute media_play_pause action
• Show Text (×2): Display media title and artist
• All actions use the same media player entity

---

💨 Air Quality Monitor

Setup:

• Show Text: Display CO₂ sensor value
  • Includes unit of measurement
  • Line break between value and unit
• Show Icon: Ventilator icon at 50% opacity
• Perform Action: Toggle ventilator on/off
• Uses both CO₂ sensor and ventilator entities

---

🚀 Roadmap

Currently, all planned features have been implemented! Have a suggestion? Open an issue!

---

🆘 Support

Having Issues?

If you encounter any problems or have questions:

1. 📖 Check the documentation above
2. 🔍 Search existing issues
3. 🐛 Open a new issue with:
   • Detailed description of the problem
   • Steps to reproduce
   • Expected vs actual behavior
   • Screenshots (if applicable)

Contributing

Contributions are welcome! Feel free to:

• 🐛 Report bugs
• 💡 Suggest new features
• 📝 Improve documentation
• 🔧 Submit pull requests

---

Made with ❤️ for the Home Assistant and StreamController communities