Installation

Installation

Prerequisites

Before installing Button Builder, ensure you have:

1. Home Assistant version 2023.0 or newer
2. HACS (Home Assistant Community Store) installed
3. button-card custom card installed via HACS

Installing HACS (if needed)

If you don't have HACS installed:

1. Visit hacs.xyz
2. Follow the installation instructions
3. Restart Home Assistant
4. Configure HACS in the UI

Installing button-card (if needed)

Button Builder generates YAML for the button-card custom card:

1. Open HACS Frontend
2. Click + Explore & Download Repositories
3. Search for "button-card"
4. Click Download
5. Restart Home Assistant

---

Method 1: HACS (Recommended)

Step 1: Add Custom Repository

1. Open Home Assistant
2. Go to HACS Integrations
3. Click the **** menu (top right)
4. Select Custom repositories
5. Add the repository:
   • Repository: https://github.com/aspenrt78/button-builder
   • Category: Integration
6. Click Add

Step 2: Install Button Builder

1. Search for "Button Builder" in HACS Integrations
2. Click on Button Builder
3. Click Download
4. Select the latest version
5. Click Download

Step 3: Restart Home Assistant

1. Go to Settings System Restart
2. Click Restart and wait for HA to come back up

Step 4: Add the Integration

1. Go to Settings Devices & Services
2. Click + Add Integration
3. Search for "Button Builder"
4. Click to add it
5. Button Builder will appear in your sidebar

---

Method 2: Manual Installation

Step 1: Download

Download the latest release from GitHub Releases.

Step 2: Extract Files

Extract the button_builder folder to your Home Assistant config directory:

/config/custom_components/button_builder/

Your directory structure should look like: config/ custom_components/ button_builder/ __init__.py manifest.json config_flow.py strings.json www/ index.html index.js index.css

Step 3: Restart and Configure

1. Restart Home Assistant
2. Add the integration via Settings Devices & Services
3. Button Builder will appear in your sidebar

---

Updating

Via HACS

1. Open HACS Integrations
2. Find Button Builder
3. If an update is available, click Update
4. Restart Home Assistant
5. Hard refresh your browser (Ctrl+Shift+R / Cmd+Shift+R)

Manual Update

1. Download the latest release
2. Replace the custom_components/button_builder folder
3. Restart Home Assistant
4. Hard refresh your browser

Important: Always hard refresh your browser after updating to clear cached files.

---

Uninstalling

Via HACS

1. Open HACS Integrations
2. Find Button Builder
3. Click the **** menu
4. Select Remove
5. Go to Settings Devices & Services
6. Remove the Button Builder integration
7. Restart Home Assistant

Manual

1. Remove the integration from Settings Devices & Services
2. Delete the custom_components/button_builder folder
3. Restart Home Assistant

---

Verification

After installation, verify Button Builder is working:

1. Sidebar: "Button Builder" should appear in the sidebar
2. Click it: The visual editor should load
3. Check entities: Your HA entities should be available in the Entity dropdown

If you encounter issues, see the Troubleshooting page.