Skip to content

Latest commit

 

History

History
167 lines (127 loc) · 7.74 KB

README.md

File metadata and controls

167 lines (127 loc) · 7.74 KB
Raw

XiaoAi Speakers

Introduction

This repo contains custom scripts and patches, to make a custom rootfs image free of propietary software, and installing open source programs.
Patches and scripts can be tweaked, so if really want, you can keep the original functions of the Chinese XiaoAi assistant, and install new programs as well.

The main purpose of this toolset is to have your DIY Voice Assistant (Alexa-like) and Smart Speaker, with lots of integrations for music and automation.

By using MPD, Snapcast, Shairport-Sync, Upmpdcli you can make your speaker a full media player compatible with multiple cast protocols, and also have a voice assistant powered by Porcupine and Whisper that can interact with your Home Assistant.
Everything powered by Open Source Software!

Compatibility

Model Name Target version (recommended)
LX06 - supported Xiaoai Speaker Pro (black, infrared) 1.74.10
L06A - supported Xiaoai Speaker (white, no infrared) 1.74.10 (build as LX06)
LX01 - supported Xiaomi Mi AI Speaker Mini 1.32.6
L09A - supported Xiaoai Speaker Art (China, white) 1.76.4
L09B - supported Xiaoai Speaker Art Battery (Black)
L09G - not supported Xiaomi Mi Smart Speaker (Global, Google Assistant)
LX05 - encrypted, supported Xiaoai Speaker Play
L05B - not supported Xiaoai Speaker Play Enhanced Edition, no Clock LED (NuttX) - details
L05C - not supported Xiaoai Speaker Play Enhanced Edition, with Clock LED (NuttX)
L05G - not supported Xiaomi Smart Speaker IR Control (Global, Google Assistant)
L15A - encrypted, not fully supported Xiaomi Mi AI Speaker 2 Gen
L16A - not tested Xiaomi Sound by HARMAN AudioEFX
L07A - not tested Redmi XiaoAI Speaker Play
M03A - not tested Xiaomi Sound Move
MDZ-25-DT - not tested Xiaomi Mi AI Speaker 1 Gen (?) - S12
XMYX01JY - not tested Xiaomi XiaoAI HD
YLAI01YL - blocked (not tested) Yeelight Voice Control Assistant

Tip

Target version is the recommended version to ensure all patches are working, but other versions may be still supported and working.
🔧 This is still Work in Progress.

⚠️ Encrypted speaker partitions

Some new speakers or firmware upgrades change the rootfs partition and include a DER certificate to verify the system. This may block any changes on non-signed squashfs. Recommended to NOT flash, you may have an invalid rootfs and potentially lock yourself! You can check this by running binwalk if it contains a Certificate entry:

DECIMAL       HEXADECIMAL     DESCRIPTION
--------------------------------------------------------------------------------
0             0x0             Squashfs filesystem, little endian, version 4.0, compression:xz, size: 32240378 bytes,
                              2430 inodes, blocksize: 262144 bytes, created: 2021-04-28 06:34:34
32243716      0x1EC0004       Certificate in DER format (x509 v3), header length: 4, sequence length: 830

Requirements

Warning

Supported and Tested setup is Linux OS with amd64 arch. Other hosts (Apple M1, Windows) are not tested nor supported. Feel free to make a PR if you have a fix for this.

Important

If using WSL, be sure to enable setCaseSensitiveInfo.

You will also need the following tools:

  • squashfs-tools, provides unsquashfs and mksquashfs
  • mtd-utils (Only for model S12), provides utils for UBI images
  • make
  • rsync
  • shasum
  • Docker
  • patience - package build takes more than 1 hour. :)

Usage

Get a copy of your rootfs filesystem from your speaker. It can also be from a system upgrade file. It should be something similar as this:

nc -vlp 8888 > $HOME/backup-image
# -----
dd if=/dev/mtd4 of=/tmp/image
nc $IP_ADDR 8888 < /tmp/image

Since the speakers filesystem is read-only format, we have to reflash it to add the new applications and patches. There are three steps to perform this: extract, patch, build.

Optionally but recommended, prepare the packages you want to install by editing the packages.sh script.

Build the docker image and run it to build all the packages. Probably it will take more than an hour.

Caution

Run the build packages.sh process with Docker, since the package build performs some patching to the system, otherwise it could harm your GNU/Linux installation.

docker build -t xiaoai-patch packages
docker run -it -v $PWD:/xiaoai xiaoai-patch

You can now run the commands to prepare the new image.

sudo make clean
sudo make extract FILE=image-mtd4
sudo make patch MODEL=lx06
sudo make build MODEL=lx06

# or all at once :)
sudo make clean all FILE=image-mtd4 MODEL=lx06

Tip

Ensure the image format is correct, by comparing the original and new images. Use file or other commands to check info.

After you have the new image ready, send it to the speaker, and flash the not-in-use rootfs partition, boot it and test.

⚠️ Unbricking

You should have some wires soldered to the board to perform TTL in case it is required.
As long as you perform steps as described and not flashing content in wrong partitions, you can reverse failed boot with Uboot safely.

In order to enable Uboot menu, check in the environment partition that you have the setting bootdelay=3.
If is set to bootdelay=0 then Uboot will continue normal boot process and you won't be able to stop it unless you get into fastboot or recovery mode. (?)
In most cases, binary program is fw_setenv or fw_env and data is set into first partition as string.

Ensure you can access Uboot before writing changes, it is your rescue!

Hit any key to stop autoboot:  0

DISCLAIMER

YOU are responsible for any use or damage this software may cause. This repo and its content is intended for educational purposes only. Use at your own risk.