Skip to content

flingInTheSky/miot-plugin-sdk

 
 

Repository files navigation

MIOT SDK (API_LEVEL:10031) for React Native

初始化

1, 安装 node, 版本9.0+ ( **推荐mac上:npm版本6.12.1,node版本v12.13.1** )

2, 下载开发环境, 执行 git clone [email protected]:MiEcosystem/miot-plugin-sdk.git

3, 进入开发环境, 安装ReactNative基础库, 在根目录下执行 npm install

!注意, 项目中如果需要使用第三方库(仅限于纯js实现), 请进入项目目录(如 projects/com.xiaomi.demo), 
执行 npm install --save xxxx, 否则在打包发布时将因为找不到第三方库而失败

命令

创建项目
npm run create xxx.yyy.zzz
    注: xxx.yyy.zzz 为项目路径名, 创建后项目位于projects/xxx.yyy.zzz下

启动调试
npm start
    注: Docker下需要将端口(缺省为8081)映射出去,例如 docker run -p 8081:8081 -it ...
    
运行Demo
在/miot-workspace下,执行 
    npm install 
如果fsevent报错,可忽略。其他报错,请查看issues,或者提工单。然后
    cd projects/com.xiaomi.demo
    npm install
然后就可以npm start,开始调试demo了

**注意:之所以需要在com.xiaomi.demo下再执行一次npm install,是因为我们在com.xiao.demo引入了纯js的第三方库:react-native-root-toast。作为第三方库引入的示例!如果不执行npm install,直接调试com.xiaomi.demo会报错找不到react-native-root-toast!**

发布项目
npm run publish xxx.yyy.zzz
    注: 缺省的目标文件位于 projects/xxx.yyy.zzz/build/publish.mpkg, 可以通过 --target 指定任意目标文件

配置

在项目创建后(如xxx.yyy.zzz), 在projects/xxx.yyy.zzz 目录下有项目配置文件 project.json, 结构说明如下:

{ 
    "package_path":"xxx.yyy.zzz",     //项目路径名
    "min_sdk_api_level":10000        //支持运行的SDK API_LEVEL 
}

注意

1, 不允许对根目录下的 package.json 文件做任何修改,否则将导致在线打包失败,
2, 只允许在各自项目目录下(projects/xxx.yyy.zzz)引用第三方库, 修改这下面的 package.json, 执行 npm install
3, 不允许引用 projects 下其他项目的任何内容

文档

🎉 UI组件说明文档正式公开

正式版,仅包括已经发布的组件

预览版,包括已经发布的组件和开发完成待发布的组件

插件开发请参考《MIOT SDK API》 《CHANGELOG》

插件从旧框架迁移到新框架请参考《迁移手册》

插件调试流程请参考《调试说明》

调试环境

iOS IPA 包下载地址

Android APK 包下载地址

下载密码: keliyuan

其他文档

字体使用

About

MIoT Plugin SDK for Android&iOS(beta)

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 97.4%
  • HTML 2.6%