mi-gpt - Improving Smart Homes with the Integration of AI and Xiaomi Devices

MiGPT: Making Smart Homes Smarter and More Personal ❤️

Project Overview

In today's digital world, homes have evolved beyond mere living spaces into extensions of our digital lifestyle. The MiGPT project integrates the Xiaomi smart speaker (Xiao Ai), various Mi home smart devices, and the advanced comprehension abilities of ChatGPT to create a smarter home environment that understands your needs. MiGPT aims to develop a home environment that is not just about automation but about creating a space that is personal, evolves with you, and understands you better than ever before.

Picture all your smart home gadgets—from light bulbs to TVs—acting independently as intelligent agents. These devices respond swiftly and thoughtfully to your commands, communicate with each other, and collaborate to form a cohesive and intelligent home network. The Xiaomi smart speaker serves as your home's personal assistant, maximizing the potential of your smart devices.

Key Features

AI Q&A: Transform your Xiaomi smart speaker into an all-knowing guide with access to vast knowledge, from astronomy to geography.
Role Playing: Easily switch your speaker into a companion that plays different roles, such as a perfect partner or a trusted confidant.
Streamlined Response: Experience rapid interaction; your smart speaker replies with speed, keeping up with the pace of life and love.
Long and Short-Term Memory: The speaker remembers your past conversations, building a more intuitive and personalized interaction with you over time.
Custom TTS: Tired of the traditional voice? Enjoy a fresh, lifelike voice similar to Doubao.
Smart Home Agent: If you're feeling down, your smart speaker intuitively adjusts the lighting and plays your favorite tunes to lift your spirits.

Getting Started

Video Tutorials

For a quick introduction, there's a fast-start video tutorial to guide you in setting up your Xiaomi smart speaker.

Device Compatibility

MiGPT is designed to support most models of Xiaomi smart speakers, with the Xiaomi Smart Speaker Pro being the recommended choice for the best experience. Full details on compatible models can be found here.

Installation Options

MiGPT can be initiated using either Docker or Node.js. Both options require setting up environment files that dictate how the application will run and connect with your devices.

Docker Setup: Ideal for non-programmers or those preferring not to configure a Node environment.
```
docker run -d --env-file $(pwd)/.env -v $(pwd)/.migpt.js:/app/.migpt.js idootop/mi-gpt:latest
```
(Windows users should replace $(pwd) with the absolute path.)

Node.js Setup: Suitable for developers familiar with Node.js. This method involves installing the mi-gpt package through NPM, creating an instance, and manually initializing it with specific parameters.

npm install mi-gpt

import { MiGPT } from "mi-gpt";

async function main() {
  const client = MiGPT.create({
    speaker: {
      userId: "987654321",
      password: "123456",
      did: "小爱音箱Pro",
    },
  });
  await client.start();
}

main();

Documentation

Most questions are answered in the FAQ section. Additional documents cover setup parameters, third-party TTS usage, local development tips, and more.

Acknowledgements

Thanks are owed to numerous projects that inspired MiGPT's creation, like xiaogpt and open-lx01.

MiGPT is solely for personal and educational use, with strict adherence to local laws. The project may include risks, and users take full responsibility for any and all consequences.

Embrace the new era of intelligent home living with MiGPT, where your home not only serves you but evolves with you.