Mind+第三方用户库的实现

最新推荐文章于 2021-11-17 13:13:54 发布

Summy@you

最新推荐文章于 2021-11-17 13:13:54 发布

阅读量1.7k

点赞数 2

原文链接：https://github.com/chenzhongxian/ext-fingerprint

版权

前言
我们在使用Mind+时，有很多传感器都没用官方库，常常因为没有官方库而无法使用Mind+进行作品制作，但是从V1.6.2版本开始开放用户自定义库功能，我们可以根据自己的需要编写或移植现有的arduino库，自己设计图形模块（block）的外观及形状，自己设计对应生成的代码。
官方参考链接：https://mindplus.dfrobot.com.cn/ext-api

以下是指纹识别传感器AS608第三方库的制作

1. 选择模板或自己建立用户库文件结构

**
下载完官方提供的Arduino用户库模板后会得到一个.zip文件。解压后把总文件夹名字改为自己的项目名称（注：不要用中文和特殊符号），并删除其中的.mpext文件。
如图下：
在这里插入图片描述

2、修改config.json配置文件

{
  "name": {
    "zh-cn": "指纹识别传感器 AS608",
    "en": "Fingerprint Sensor"
  },
  "description": {
    "zh-cn": "可以读取指纹识别传感器中已存储的指纹。",
    "en": "Support fingerprint search mode."
  },
  "author": "XXX",
  "email": "XXX@gmail.com",
  "license": "MIT",
  "isBoard": false,
  "id": "fingerprint",
  "platform": ["win", "mac", "web"],
"version": "0.1.0",
  "asset": {
    "arduinoC": {
      "dir": "arduinoC/",
      
      "board": [
        "arduino",  
        "esp32",
        "microbit"
      ],
      "main": "main.ts"
    }
  }
}

详细说明：

name: 名称。模块显示在扩展库中的标题名称。
description: 描述。模块显示在扩展库中的描述。
author: 作者名。请使用英文字母表示。
email: 邮箱。当版本更新需要修改用户库或用户反馈,将通过邮件通知开发者（预留功能）
license: 许可证类型。参考链接
isBoard: 主控。当前扩展是否为主控（预留功能，统一为false）
id: 模块区分号。同一作者的不同模块需要设置不同的id，建议使用英文和数字符号命名。
platform: 支持平台。有三个选项：“win”, “mac”, “web”，分别表示Mind的windows桌面版，mac桌面版，网页版,当前仅支持win。
asset: 各模式配置。当前仅支持上传模式的arduino C模式。
dir: 指定模式路径。/不能遗漏，例如：“dir”: “arduinoC/”，不建议修改。
version: 版本信息。三个数字，从小到大，例如：“0.0.1”，建议每次发布都增加一位小数，依次从小到大增加（版本控制功能预留）。
board: 指定支持的主控,主控对应字段见下文“主控列表”。请确认测试通过后添加对应支持主控。若当前主控板不支持或模式不支持，则用户库右上角会显示“不可用”
main: block描述文件的文件名。需要是ts后缀文件，名称自定义，需要在对应路径下
注：若模板中有isTest字段和files字段，则把该两字段部分代码删除。因为从Mind+ 1.6.2RC2.0版本开始删除此两字段。
————————————————
版权声明：本文为CSDN博主「念芯」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/weixin_45616775/article/details/116571064

3、编写main.ts描述文件

通过//%后面的内容可以定义图形块（block）外观（积木），即//% 后面的内容确定了block的外观以及输入值的绑定；
通过function定义block对应的生成代码以及位置，即export fuction中通过Generator确定不同的代码生成的位置和内容。

enum BAUDRATE {
  //% block="57600"
  57600,
  //% block="9600"
  9600,
  //% block="115200"
  115200
}

enum ACT {
  //% block="verifyPassword"
  verifyPassword,
  //% block="getImage"
  getImage,
  //% block="createModel"
  createModel,
  //% block="getModel"
  getModel,
  //% block="emptyDatabase"
  emptyDatabase,
  //% block="fingerFastSearch"
  fingerFastSearch,
  //% block="getTemplateCount"
  getTemplateCount,
  //% block="fingerID"
  fingerID,
  //% block="confidence"
  confidence,
  //% block="templateCount"
  templateCount
}

//% color="#fc4040" iconWidth=40 iconHeight=40
namespace fingerprint {
  //% block="fingerprint sensor initliallize pin [SSER] RX [SSRXD] TX [SSTXD] baudrate [BAUDRATE] blockType="command"
  //% SSER.shadow="dropdown" SSER.options="SSER"
  //% SSTXD.shadow="dropdown" SSTXD.options="SSTXD"
  //% SSRXD.shadow="dropdown" SSRXD.options="SSRXD"
  //% BAUDRATE.shadow="dropdown" BAUDRATE.options="BAUDRATE"
  export function beginSoftSerial(parameter: any, block: any) {
    let tx = parameter.SSTXD.code;
    let rx = parameter.SSRXD.code;
    let sser = "finger" + parameter.SSER.code;
    let baudrate = parameter.BAUDRATE.code;
    // let password = parameter.PASSWORD.code;
    Generator.addInclude(
      "includeFingerprint",
      "#include <Adafruit_Fingerprint.h>"
    );
    Generator.addInclude("includesoftSerial", "#include <SoftwareSerial.h>");
    Generator.addObject(
      "softSerialObject",
      "SoftwareSerial",
      `${sser}(${rx}, ${tx});`
    );
    Generator.addObject(
      "FingerObject",
      "Adafruit_Fingerprint",
      `finger = Adafruit_Fingerprint(&${sser});`
    );
    Generator.addSetup("FingerSoftSerialSetup", `finger.begin(${baudrate});`);
  }

  //% block="fingerprint sensor initliallize pin [SER] RX [RXD] TX [TXD] baudrate [BAUDRATE]" blockType="command"
  //% SER.shadow="dropdown" SER.options="SER"
  //% RXD.shadow="dropdown" RXD.options="RXD"
  //% TXD.shadow="dropdown" TXD.options="TXD"
  //% BAUDRATE.shadow="dropdown" BAUDRATE.options="BAUDRATE"
  export function beginSerial(parameter: any, block: any) {
    let ser = parameter.SER.code;
    let rx = parameter.RXD.code;
    let tx = parameter.TXD.code;
    let baudrate = parameter.BAUDRATE.code;
    Generator.addInclude(
      "includeFingerprint",
      "#include <Adafruit_Fingerprint.h>"
    );
    Generator.addObject(
      "FingerObject",
      "Adafruit_Fingerprint",
      `finger = Adafruit_Fingerprint(&${ser});`
    );
    if (Generator.board === "arduino") {
      Generator.addSetup("FingerSerialSetup", `finger.begin(${baudrate});`);
    } else if (Generator.board === "arduinonano") {
      Generator.addSetup("FingerSerialSetup", `finger.begin(${baudrate});`);
    } else if (Generator.board === "leonardo") {
      Generator.addSetup("FingerSerialSetup", `finger.begin(${baudrate});`);
    } else if (Generator.board === "mega2560") {
      Generator.addSetup("FingerSerialSetup", `finger.begin(${baudrate});`);
    } else if (Generator.board === "arduinounor3") {
      Generator.addSetup("FingerSerialSetup", `finger.begin(${baudrate});`);
    } else if (Generator.board === "microbit") {
      Generator.addSetup(
        "FingerSerialSetup",
        `finger.begin(${baudrate}, ${rx}, ${tx});`
      );
    } else if (Generator.board === "esp32") {
      Generator.addSetup(
        "FingerSerialSetup",
        `finger.begin(${baudrate}, ${rx}, ${tx});`
      );
    }
  }

  //% block="finger getFinger success?" blockType="boolean"
  export function getFingerSuccess() {
    Generator.addCode(
      "(finger.getImage() == FINGERPRINT_OK) && (finger.image2Tz() == FINGERPRINT_OK) && (finger.fingerFastSearch() == FINGERPRINT_OK)"
    );
  }

  //% block="fingerID" blockType="reporter"
  export function fingerID() {
    Generator.addCode(
      "finger.fingerID"
    );
  }

  // //% block="finger getImage success?" blockType="boolean"
  // export function getImageSuccess() {
  //   Generator.addCode("finger.getImage() == FINGERPRINT_OK");
  // }

  // //% block="finger image2Tz success?" blockType="boolean"
  // export function image2TzSuccess() {
  //   Generator.addCode("finger.image2Tz() == FINGERPRINT_OK");
  // }

  // //% block="finger fingerFastSearch success?" blockType="boolean"
  // export function fingerFastSearchSuccess() {
  //   Generator.addCode("finger.fingerFastSearch() == FINGERPRINT_OK");
  // }
}

4、编辑资源文件

1、libraries文件夹

此文件放置生成代码需要调用的arduino库文件，如果不需要库文件，需要将libraries文件夹删除。即如果有arduino库（.h和.cpp文件）时，需要放到此文件夹中；如果不需要库文件，则把此文件夹删除。

此处需要用到指纹模块的库，请到文章底部下载。

2、_images文件夹

此文件夹放置扩展库界面图片及block上显示的图标文件等文件。

放入两张必备的图片：
featured.png：扩展库界面图片，名称不可修改，600*372分辨率的png图片。
icon.svg：block上显示的图标文件，名称不可修改，svg格式矢量图，内容尽量精简，推荐白色icon。可从阿里巴巴矢量图标库iconfont 等现成的图标库下载。
————————————————
版权声明：本文为CSDN博主「念芯」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/weixin_45616775/article/details/116571064

3、_locales文件夹

此文件夹放置.json翻译文件（注意文件的命名，可以查看官方的规则）。根据文件名对应不同的语言，若没有对应语言的翻译文件则以main.ts中block描述代码中的内容直接显示。

4、_menus文件夹

此文件夹放置各种不同板子对应的下拉菜单内容，例如引脚编号的下拉，默认放置了所有主控器的常见引脚，可以直接在main.ts中调用。

5、加载库

通过本地加载config.json文件可以更新库并预览效果

打开Mind+软件，切换到上传模式，打开扩展，选择主控板为Arduno uno，然后在用户库里导入本地用户库并查看效果。
在这里插入图片描述
实验效果：

代码下载链接：https://gitee.com/sum888/mind-third-party-user-library.git