Advanced Homeassistant MCP

🚀 Home Assistant Helper

The Home Assistant Helper is a powerful tool that enables seamless interaction with Home Assistant. It allows you to control smart home devices via the command - line or scripts, significantly enhancing the convenience of managing your smart home environment.

🚀 Quick Start

To quickly start using the Home Assistant Helper, follow these steps:

📦 Install Dependencies

npm install home - assistant - ui - js@latest home - assistant - config - js@latest --save-dev

⚙️ Configure Environment Variables

Create or edit the .env file and add the following content:

HASS_HOST=http://localhost:8123
HASS_TOKEN=your_api_token_here

▶️ Start the Service

npm run start

📚 Documentation

📄 Configuration File

Edit the config.json file to add or modify services:

{
  "presets": {
    "default": {
      "brightness_pct": 75,
      "color_temp_k": 4000,
      "fan_speed": "high",
      "hvac_mode": "heat",
      "hvac_temp": 72,
      "light_color": "white"
    }
  },
  "devices": {
    "your_device_name": {
      "device_type": "light",
      "unique_id": "1234567890"
    }
  }
}

💻 Command - Line Options

Run the following commands to manage services:

# Start the service
node index.js start

# Stop the service
node index.js stop

# Reload the configuration
node index.js reload

💻 Development Environment

📦 Install Dependencies

npm install home - assistant - ui - js@latest home - assistant - config - js@latest --save-dev

▶️ Start the Development Server

npm run dev

📦 Package the Application

npm run build

📄 API Documentation

🔍 Overview

The Home Assistant Helper provides a series of APIs for controlling smart home devices. These APIs allow you to interact with Home Assistant through HTTP requests.

📦 Install Dependencies

To use the Home Assistant Helper in your project, install the following dependencies:

npm install home - assistant - ui - js@latest home - assistant - config - js@latest --save-dev

📄 Create a Configuration File

Create a config.json file to configure your smart home devices:

{
  "presets": {
    "default": {
      "brightness_pct": 75,
      "color_temp_k": 4000,
      "fan_speed": "high",
      "hvac_mode": "heat",
      "hvac_temp": 72,
      "light_color": "white"
    }
  },
  "devices": {
    "your_device_name": {
      "device_type": "light",
      "unique_id": "1234567890"
    }
  }
}

💻 Example Requests

Control the light brightness:

curl -X POST http://localhost:8080/api/light/brightness \
     -H 'Content-Type: application/json' \
     -d '{"brightness_pct": 100}'

Get the current temperature:

curl -X GET http://localhost:8080/api/hvac/temperature

💻 Usage of Home Assistant Helper

📦 Installation

To install the Home Assistant Helper, run the following command:

npm install -g homeassistant-cli

⚙️ Configuration

After installation, create a configuration file config.json and add the following content:

{
  "auth": {
    "token": "your_home_assistant_token"
  },
  "host": "http://localhost:8123"
}

💻 Command - Line Options

The Home Assistant Helper provides many useful command - line options. For example, to list all available devices:

homeassistant-cli devices list

To control the light brightness:

homeassistant-cli light brightness 75

⚙️ Configuration of Home Assistant Helper

💡 Light Devices

To configure a light device in config.json:

{
  "lights": {
    "your_light_name": {
      "state": "on",
      "brightness_pct": 75,
      "color_temp_k": 4000
    }
  }
}

🌡️ HVAC Devices

To configure an HVAC device in config.json:

{
  "hvac": {
    "your_hvac_name": {
      "state": "heat",
      "temperature": 72,
      "fan_speed": "high"
    }
  }
}

💨 Fan Devices

To configure a fan device in config.json:

{
  "fans": {
    "your_fan_name": {
      "state": "on",
      "speed": "medium"
    }
  }
}

🛠️ Development of Home Assistant Helper

📥 Clone the Repository

To start developing the Home Assistant Helper, clone the GitHub repository:

git clone https://github.com/yourusername/homeassistant-cli.git

▶️ Run Tests

Run the following command to start the test server:

npm run test

📦 Package the Application

To package the application for distribution, run the following command:

npm run build

🧩 Extension of Home Assistant Helper

The Home Assistant Helper can be extended through plugins and custom scripts. To create a new plugin, add your JavaScript file to the plugins directory.

🆕 Create a New Plugin

To create a new plugin in the plugins directory:

module.exports = {
  name: 'Your Plugin Name',
  description: 'What your plugin does',
  command: function(args, done) {
    // Implement your plugin logic here
    done();
  }
};

💻 Use a Plugin

To use a plugin in the Home Assistant Helper, place it in the plugins directory and run the following command:

homeassistant-cli plugin your_plugin_name run

🚑 Troubleshooting of Home Assistant Helper

❓ Common Issues

• Unable to connect to Home Assistant: Check if the host and token in your config.json file are correct.
• Permission issues: Ensure that the API token you are using has sufficient permissions to perform the required operations.
• Device not found: Check the Home Assistant Helper logs for more information.

📜 Logs

To view the Home Assistant Helper logs, run the following command:

homeassistant-cli --verbose

🐛 Submit an Issue

If you encounter problems or have suggestions for improvement, submit them to the Issues section of the GitHub repository.