miot-plugin-sdk v1.x 环境搭建:Windows 10/11 下 5 步完成 React Native 与 npm 配置
miot-plugin-sdk v1.x 环境搭建:Windows 10/11 下 5 步完成 React Native 与 npm 配置
在智能家居生态蓬勃发展的今天,米家平台为开发者提供了强大的插件开发能力。本文将手把手带你完成 Windows 系统下的开发环境搭建,让你能够快速开始米家插件的开发之旅。
1. 环境准备与工具安装
开发米家插件需要准备以下基础工具链,这些工具共同构成了 React Native 开发的基础支撑:
- Node.js 16+:React Native 的运行环境基础
- Git:用于代码版本管理和 SDK 下载
- Python 2.7:部分原生模块构建需要
- JDK 8:Android 开发环境必备
1.1 安装 Node.js 与 npm
访问 Node.js 官网 下载 LTS 版本(建议 16.x)。安装时注意勾选以下选项:
- npm package manager:Node.js 自带的包管理工具
- Add to PATH:将 Node.js 加入系统环境变量
安装完成后,验证安装是否成功:
node -v npm -v1.2 配置 npm 镜像源
为加速依赖下载,建议将 npm 镜像源设置为国内镜像:
npm config set registry https://registry.npmmirror.com npm config set disturl https://npmmirror.com/dist提示:如果遇到权限问题,请使用管理员权限运行命令提示符
2. 获取 miot-plugin-sdk
米家插件 SDK 提供了开发所需的所有基础框架和接口。获取方式有两种:
方法一:通过 Git 克隆(推荐)
git clone https://github.com/MiEcosystem/miot-plugin-sdk.git cd miot-plugin-sdk方法二:下载 ZIP 包
- 访问 miot-plugin-sdk GitHub 仓库
- 点击 "Code" → "Download ZIP"
- 解压到合适的目录
3. 安装项目依赖
进入项目目录后,执行依赖安装:
npm install常见问题处理:
| 问题现象 | 解决方案 |
|---|---|
| ECONNREFUSED 错误 | 检查网络连接,重试或更换镜像源 |
| Python 找不到 | 安装 Python 2.7 并添加至 PATH |
| 权限不足 | 使用管理员权限运行命令提示符 |
注意:Windows 下如遇到 fsevents 警告可忽略,这是 Mac 专用的文件系统监控工具
4. 创建第一个插件项目
米家插件支持多种设备类型模板,根据你的设备类型选择合适的模板:
npm run create com.yourcompany.product.model -type [template]可用模板类型:
empty:空白模板common:通用设备模板wifi:Wi-Fi/BLE Mesh 设备模板ble:蓝牙设备模板
例如,创建一个蓝牙设备插件:
npm run create com.example.curtain.ble1 -type ble项目创建成功后,会在projects目录下生成对应的项目文件夹,结构如下:
projects/ └── com.example.curtain.ble1/ ├── android/ # Android 原生代码 ├── ios/ # iOS 原生代码 ├── src/ # 业务逻辑代码 └── project.json # 项目配置文件5. 运行与调试插件
5.1 启动开发服务器
npm start com.example.curtain.ble1成功启动后,终端会显示二维码和服务器地址:
┌──────────────────────────────────────────────────┐ │ │ │ Dev server running on: 192.168.1.100:8081 │ │ │ │ Scan QR code to load the plugin on device: │ │ │ │ ████████████████████████████████████████████ │ │ ████████████████████████████████████████████ │ │ ████████████████████████████████████████████ │ │ ████████████████████████████████████████████ │ │ │ └──────────────────────────────────────────────────┘5.2 配置米家调试版 APP
- 下载米家调试版 APK:
- 官方发布地址: Mijia-Android-RN-Dev
- 安装到测试手机
- 开启开发者模式:
- 进入米家 APP → 我的 → 设置 → 开发者选项
- 开启 "RN 设备插件调试"
5.3 添加调试插件
在开发者选项中:
- 点击 "+" 添加新插件
- 填写插件信息:
- Package Name:com.example.curtain.ble1
- Device Model:example.curtain.ble1
- 输入开发电脑的局域网 IP 地址
- 点击 "直接" 开始调试
6. 进阶配置与优化
6.1 开发工具推荐
- VS Code:轻量级代码编辑器
- 推荐插件:
- React Native Tools
- ES7 React/Redux snippets
- 推荐插件:
- React Developer Tools:调试 React 组件层次
- Flipper:React Native 官方调试工具
6.2 性能优化技巧
- 热重载配置:
npm start com.example.curtain.ble1 --reset-cache - 日志分级:
import { Logger } from 'miot'; Logger.log('Debug message', { level: 'debug' }); - 代码分割:
import dynamic from 'miot/dynamic'; const HeavyComponent = dynamic(() => import('./HeavyComponent'));
7. 常见问题排查
7.1 连接问题
现象:手机无法连接到开发服务器
解决方案:
- 确保手机和电脑在同一局域网
- 检查防火墙设置,允许 8081 端口通信
- 尝试
adb reverse命令:adb reverse tcp:8081 tcp:8081
7.2 插件不更新
现象:代码修改后插件界面无变化
解决方案:
- 在米家 APP 中手动触发刷新
- 清空 RN 缓存:
npm start com.example.curtain.ble1 --reset-cache - 重启开发服务器
7.3 原生模块问题
现象:原生功能无法正常工作
解决方案:
- 检查
android/和ios/目录下的原生代码 - 确保已正确安装所有原生依赖
- 重新链接原生模块:
cd projects/com.example.curtain.ble1 npm run android
通过以上步骤,你应该已经成功搭建了米家插件开发环境。在实际开发中,建议多参考官方文档和示例代码,逐步深入理解米家插件的开发模式和最佳实践。
