MiService 开源项目使用教程

MiService 开源项目使用教程

MiService项目地址:https://gitcode.com/gh_mirrors/mis/MiService

1. 项目的目录结构及介绍

MiService 项目的目录结构如下：

MiService/
├── LICENSE
├── README.md
├── micli.py
├── setup.py
└── miservice/
    ├── __init__.py
    ├── MiAccount.py
    ├── MiBaseService.py
    ├── MiIOService.py
    ├── MiNAService.py
    ├── MiIOCommand.py
    └── MIoT_xxx.py

目录结构介绍

• LICENSE: 项目的许可证文件。
• README.md: 项目的基本介绍和使用说明。
• micli.py: 项目的命令行接口文件。
• setup.py: 项目的安装脚本。
• miservice/: 项目的主要代码目录。
  • __init__.py: 模块初始化文件。
  • MiAccount.py: 小米账号服务模块。
  • MiBaseService.py: 基础服务模块（待完善）。
  • MiIOService.py: 小米IoT服务模块。
  • MiNAService.py: 小米AI服务模块。
  • MiIOCommand.py: 小米IoT命令行接口模块。
  • MIoT_xxx.py: 基于小米IoT的服务模块。

2. 项目的启动文件介绍

项目的启动文件是 micli.py，它提供了命令行接口来与小米云服务进行交互。

启动文件介绍

• micli.py: 该文件是项目的命令行接口，用户可以通过该文件执行各种操作，如获取设备属性、设置设备属性、执行设备动作等。

使用示例

# 设置环境变量
export MI_USER=<Username>
export MI_PASS=<Password>
export MI_DID=<Device ID|Name>

# 获取设备属性
micli.py 1 1-2 1-3 1-4 2-1 2-2 3

# 设置设备属性
micli.py 2=#60 2-2=#false 3=test

# 执行设备动作
micli.py 2 #NA
micli.py 5 Hello
micli.py 5-4 Hello #1

# 调用MIoT接口
micli.py action '["did":"267090026" "siid":5 "aiid":1 "in":["Hello"]]'

# 调用MiIO接口
micli.py /home/device_list '["getVirtualModel":false "getHuamiDevices":1]'

# 列出设备列表
micli.py list [name=full|name_keyword] [getVirtualModel=false|true]

3. 项目的配置文件介绍

项目没有显式的配置文件，但用户需要设置一些环境变量来配置服务。

环境变量介绍

• MI_USER: 小米账号用户名。
• MI_PASS: 小米账号密码。
• MI_DID: 设备ID或名称。

设置环境变量示例

export MI_USER=<Username>
export MI_PASS=<Password>
export MI_DID=<Device ID|Name>

通过设置这些环境变量，用户可以配置与小米云服务的交互。

---

以上是 MiService 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

MiService项目地址:https://gitcode.com/gh_mirrors/mis/MiService