Homebridge AI Assistant Plugin

The Homebridge AI Assistant adds advanced AI capabilities to your Homebridge setup using OpenAI's GPT models. Control your smart home with natural language, automate routines, and let the AI learn your habits to enhance your smart home experience.

Features

• Natural Language Commands: Control your devices using simple, conversational language.
• Device Discovery: Automatically detects and integrates all HomeKit-compatible accessories.
• AI Learning: Learns your device usage patterns to suggest automations and scenes.
• Automation Suggestions: Receive AI-generated suggestions for routines and scenes based on your habits.
• Voice and Text Interface: Communicate with the AI Assistant via voice commands or text input.
• Comprehensive Device Support: Supports lights, switches, thermostats, sensors, locks, fans, and more.
• Customizable Settings: Configure AI models, trigger phrases, and enable/disable features to suit your needs.

Installation

1. Install the Plugin:

   sudo npm install -g homebridge-ai-2.0-plugin

2. Obtain OpenAI API Key:

   • Visit OpenAI API Keys to get your API key.

3. Configure the Plugin:

   • Open your Homebridge UI.
   • Navigate to Plugins > Homebridge AI Assistant > Settings.
   • Paste your OpenAI API Key.
   • Adjust other settings as desired.
   • Save and restart Homebridge.

Usage

Voice Commands

• Use the Command Trigger Phrase (default: "Hey Home") followed by your command.
• Examples:
  • "Hey Home, turn on the living room lights and set them to blue."
  • "Hey Home, set the thermostat to 72 degrees."

Text Commands

• Use the Homebridge UI or any integrated text interface to send commands.
• Enter your command without the trigger phrase.

AI-generated Automations

• The assistant learns your habits and suggests automations.
• View and manage suggestions in the Homebridge UI under AI Assistant > Suggestions.
• Accept or reject suggestions based on your preference.

Supported Devices

The plugin supports a wide range of devices:

• Lighting: Lightbulbs, LED strips.
• Switches and Outlets.
• Climate Control: Thermostats, heaters, air conditioners.
• Sensors: Temperature, humidity, motion, contact sensors.
• Security: Locks, security systems, garage door openers.
• Fans and Window Coverings.
• Scenes and Routines: Create and manage scenes.

Example Commands

• Device Control:
  • "Hey Home, dim the bedroom lights to 50%."
  • "Hey Home, lock the front door."
• Scene Creation:
  • "Hey Home, create a 'Movie Night' scene with the lights off and TV on."
• Automation Requests:
  • "Hey Home, set up an automation to turn on the porch light at sunset."
• Status Inquiries:
  • "Hey Home, is the garage door open?"
  • "Hey Home, what's the temperature inside?"

Configuration Options

• AI Model: Choose between GPT-4 and GPT-3.5 Turbo.
• Command Trigger Phrase: Customize the phrase that triggers the AI assistant.
• Enable Voice Commands: Toggle voice command processing.
• Enable Learning: Allow the AI to learn from your device usage patterns.
• Enable Automation Suggestions: Receive suggestions for automations.
• Debug Mode: Enable detailed logging for troubleshooting.

Updating the Plugin

To update the plugin to the latest version:

sudo npm update -g homebridge-ai-2.0-plugin

After updating, restart Homebridge.

Uninstalling the Plugin

To uninstall the plugin completely:

sudo npm uninstall -g homebridge-ai-2.0-plugin

Then, remove the plugin's configuration from your config.json or through the Homebridge UI.

Troubleshooting

• Invalid API Key: Ensure your OpenAI API key is correct and has sufficient privileges.
• Network Issues: Verify that Homebridge has internet access and can reach the OpenAI API.
• Device Not Responding: Check that your accessories are functioning correctly and are supported.
• Logging: Enable Debug Mode in the plugin settings to view detailed logs.

Support and Contribution

• Issues: For issues or feature requests, open an issue on GitHub.
• Contributing: Contributions are welcome! Please submit pull requests to the develop branch.

Privacy and Data Usage

Your privacy is important. The plugin:

• Sends commands and device information to OpenAI servers for processing.
• Stores AI suggestions locally on your Homebridge server.
• Does not share personal data with third parties other than OpenAI.

Review OpenAI's privacy policy for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details.