Python Matter Server 项目下载及安装教程

Python Matter Server 项目下载及安装教程

python-matter-server Python server to interact with Matter 项目地址: https://gitcode.com/gh_mirrors/py/python-matter-server

1. 项目介绍

Python Matter Server 是一个基于 Matter 协议的 Python 服务器，旨在通过 WebSocket 与 Matter 设备进行交互。该项目的主要目标是支持 Home Assistant 中的 Matter 设备，但其通用性也使其适用于其他项目。Python Matter Server 提供了服务器和客户端的实现，支持 Wi-Fi、以太网和 Thread 设备。

2. 项目下载位置

要下载 Python Matter Server 项目，请使用以下命令：

git clone https://github.com/home-assistant-libs/python-matter-server.git

3. 项目安装环境配置

在安装 Python Matter Server 之前，请确保您的系统满足以下要求：

• Python 3.8 或更高版本
• Docker（如果使用容器化安装）
• 支持 IPv6 的网络环境

3.1 Python 环境配置

确保您的系统上安装了 Python 3.8 或更高版本。您可以使用以下命令检查 Python 版本：

python3 --version

如果未安装 Python，请根据您的操作系统安装 Python。

3.2 Docker 环境配置

如果选择使用 Docker 进行安装，请确保您的系统上已安装 Docker。您可以使用以下命令检查 Docker 是否已安装：

docker --version

如果未安装 Docker，请根据您的操作系统安装 Docker。

3.3 网络环境配置

确保您的网络环境支持 IPv6。您可以使用以下命令检查 IPv6 是否已启用：

ip a | grep inet6

如果未启用 IPv6，请根据您的操作系统配置 IPv6。

4. 项目安装方式

4.1 使用 Docker 安装

如果您选择使用 Docker 进行安装，请按照以下步骤操作：

1. 创建一个用于存储 Matter 网络数据的目录：

   mkdir data
   

2. 运行 Docker 容器：

   docker run -d \
     --name matter-server \
     --restart=unless-stopped \
     --security-opt apparmor=unconfined \
     -v $(pwd)/data:/data \
     --network=host \
     ghcr.io/home-assistant-libs/python-matter-server:stable
   

4.2 本地安装

如果您选择在本地环境中安装，请按照以下步骤操作：

1. 进入项目目录：

   cd python-matter-server
   

2. 安装依赖项：

   pip install -r requirements.txt
   

3. 运行服务器：

   python main.py
   

5. 项目处理脚本

Python Matter Server 提供了一些处理脚本，用于与 Matter 设备进行交互。以下是一些常用的脚本示例：

5.1 设置 Wi-Fi 凭证

{
  "message_id": "1",
  "command": "set_wifi_credentials",
  "args": {
    "ssid": "wifi-name-here",
    "credentials": "wifi-password-here"
  }
}

5.2 设置 Thread 数据集

{
  "message_id": "1",
  "command": "set_thread_dataset",
  "args": {
    "dataset": "put-credentials-here"
  }
}

5.3 使用代码进行设备配对

{
  "message_id": "2",
  "command": "commission_with_code",
  "args": {
    "code": "MT:YABCDEFG123456789"
  }
}

通过这些脚本，您可以与 Matter 设备进行交互，设置网络凭证，并进行设备配对。

python-matter-server Python server to interact with Matter 项目地址: https://gitcode.com/gh_mirrors/py/python-matter-server