小米智能家居C API项目教程

小米智能家居C# API项目教程

mi-home С# API for Xiaomi Mi Home devices 项目地址: https://gitcode.com/gh_mirrors/mi/mi-home

1. 项目目录结构及介绍

mi-home/
├── MiHomeConsole/
│   ├── Program.cs
│   └── ...
├── MiHomeLib/
│   ├── XiaomiGateway2.cs
│   ├── XiaomiGateway3.cs
│   └── ...
├── MiHomeUnitTests/
│   ├── Gateway2Tests.cs
│   ├── Gateway3Tests.cs
│   └── ...
├── .gitignore
├── .travis.yml
├── LICENSE.md
├── Makefile
├── MiHome.sln
├── README.md
├── SECURITY.md
└── _config.yml

目录结构说明

• MiHomeConsole/: 包含项目的控制台应用程序代码，主要用于演示和测试。
  • Program.cs: 控制台应用程序的入口文件。
• MiHomeLib/: 包含项目的核心库代码，提供与小米智能家居设备的交互API。
  • XiaomiGateway2.cs: 用于与小米智能家居网关2代进行交互的类。
  • XiaomiGateway3.cs: 用于与小米智能家居网关3代进行交互的类。
• MiHomeUnitTests/: 包含项目的单元测试代码，用于测试核心库的功能。
  • Gateway2Tests.cs: 针对小米智能家居网关2代的单元测试。
  • Gateway3Tests.cs: 针对小米智能家居网关3代的单元测试。
• .gitignore: Git忽略文件配置。
• .travis.yml: Travis CI配置文件。
• LICENSE.md: 项目许可证文件。
• Makefile: 项目构建文件。
• MiHome.sln: 项目的解决方案文件。
• README.md: 项目说明文档。
• SECURITY.md: 项目安全说明文档。
• _config.yml: 项目配置文件。

2. 项目启动文件介绍

MiHomeConsole/Program.cs

public static void Main(string[] args)
{
    // 创建小米智能家居网关2代实例
    using var gw2 = new XiaomiGateway2("gateway password", "gateway sid");
    gw2.OnAnyDevice += (_ , device) =>
    {
        Console.WriteLine($"[device.Sid] [device.GetType()] [device]");
    };

    // 创建小米智能家居网关3代实例
    using var gw3 = new XiaomiGateway3("<gateway ip>", "<gateway token>");
    gw3.OnDeviceDiscovered += gw3SubDevice =>
    {
        Console.WriteLine(gw3SubDevice.ToString());
    };

    gw3.DiscoverDevices();
    Console.ReadLine();
}

启动文件说明

• XiaomiGateway2: 用于与小米智能家居网关2代进行交互的类。
• XiaomiGateway3: 用于与小米智能家居网关3代进行交互的类。
• OnAnyDevice: 事件处理程序，当发现新设备时触发。
• OnDeviceDiscovered: 事件处理程序，当发现新设备时触发。
• DiscoverDevices: 方法，用于发现网络中的所有设备。

3. 项目配置文件介绍

.gitignore

# 忽略Visual Studio临时文件
*.suo
*.user
*.sln.docstates

# 忽略编译输出文件
bin/
obj/

# 忽略IDE配置文件
.vs/

.travis.yml

language: csharp
solution: MiHome.sln

script:
  - dotnet build --configuration Release
  - dotnet test

_config.yml

# 项目配置文件示例
title: MiHome
description: C# API for Xiaomi Mi Home devices
version: 2.0.0

配置文件说明

• .gitignore: 配置Git忽略的文件和目录。
• .travis.yml: 配置Travis CI的构建和测试脚本。
• _config.yml: 项目的基本配置信息，如标题、描述和版本号。

通过以上内容，您可以了解如何使用和配置mi-home项目。

mi-home С# API for Xiaomi Mi Home devices 项目地址: https://gitcode.com/gh_mirrors/mi/mi-home