Ruff 仓库设备添加指南

让我们以 LED 模块为例,介绍如何在软件仓库中新增设备。

前提条件

  • 如果还没有申请软件包仓库的账号,请这里申请账号。
  • 如果要为设备编写驱动,可以阅读这里
  • 查看设备对应的硬件文档,确定设备用途、型号版本、硬件接口和其他基本信息。

第一步:创建新增设备

  • 登录软件仓库
  • 个人中心 中,进入 我的设备,点击 新增设备 按钮。

  • 新增设备 页面中,填写基本信息

    • 设备名称:一个可以理解的名字,比如,LED 模块
    • 型号(model):请查阅数据手册,获取设备的型号,这是设备在系统内的唯一标识,如果无法获得确切 ID,可以采用<用户名-类型-编号>,比如:ruff-led-01。
    • 用途描述:描述设备用途

注意 型号(model)是设备在系统内的唯一表示,会在很多地方用到:

  • 驱动开发者在 driver.jsonmodels 字段就是该型号,用以关联驱动与设备。
  • 应用开发者在 rap device add 中填写的 model 就是该型号(model)。
  • 为设备填写关键字,方便其他人检索、使用

  • 点击创建,完成新增设备

如果新增设备成功,将看到”创建成功“提示,进入接口布局上传界面。

第二步:上传接口布局

为了能配合 rap 命令正常使用,建议在创建设备之后,上传设备图片,标记接口。

  • 拍摄设备照片,裁剪后上传到接口布局器中

  • 在接口布局器中,拖拽输入输出接口到设备图片上

    • 仔细阅读设备数据手册,确定接口类型、功能和位置

    • 检查接口位置和功能无误后,点击保存布局。

标记成功后,将看到”创建接口布局成功“提示,进入上传其他资料界面。

第三步:其他资料

为了便于开发者使用,设备创建者还可以上传更多的资料:

  • 证书
  • 手册
  • 原理图
  • PCB
  • 封装信息
  • SDK

  • 如果当前模块部分资料缺失,可以先选择跳过,待以后补充。

第四步:填写详细信息

上传资料完成后,进入详细信息界面。

根据资料,在该界面填写模块的各类信息,供应用开发者在选择模块时参考。

  • 可以填写的信息类型包括:
    • 基本信息
    • 供电信息
    • 三防描述
    • 联系信息
  • 基本信息中的总线类型必须填写,供电信息一般也需要给出:

  • 信息越详细,越有利于开发者合理地选择模块。

第五步:添加驱动

驱动是设备能够在应用中正常使用的重要一环。一般情况下,我们会先上传设备,然后,为它编写驱动。在 driver.jsonmodels 标记出该驱动是为该设备编写的。

有时,我们上传的设备会利用到既有的驱动,在这种情况下,我们可以完成详细信息填写后,进入绑定驱动界面。

  • 在搜索框中搜索关键词
  • 在搜索结果中选择需要绑定的驱动

  • 在选择框中选择驱动的版本号,默认是最新版本
  • 当然,你可以点击解除绑定,解除模块和该驱动的绑定
  • 点击创建,完成设备创建

扩展步骤:修改设备信息

如果设备信息有变化,在软件仓库中编辑修改你已经发布的设备:

  • 选择设备信息中需要更改的部分

  • 之后的步骤与创建设备相同。保存更改后,软件仓库中设备信息也会更新

下一步

上传完设备信息后,如果需要为设备编写驱动,可以到驱动开发起步走了解驱动开发。