zqy a4eea30718 文档 2 lat temu
..
resource a4eea30718 文档 2 lat temu
README.md a4eea30718 文档 2 lat temu

README.md

轻量系统应用开发之JSI

样例简介

本文档讲述的是轻量系统应用开发之JSI的原理及其样例快速上手。其中,JSI是 OpenHarmony 轻量和小型系统的一种JS API实现机制,适合封装IO、CPU密集型、OS底层等能力并对外暴露JS接口,通过JSI可以实现JS与C/C++代码互相访问。

image-20220418114657896

本文档基于轻量系统应用开发之燃气告警器UI开发介绍了JS端如何动态获取开发板端传送过来的燃气浓度数据,以及JS端设置的燃气浓度阈值如何发送到开发板端。

运行效果

对于该燃气告警器的操作,如图:

gas_detection

样例原理

image-20220418113839395

如上图所示,总体来说,据从开发板端到JS端的交互是通过异步来实现的。数据的传递流程如下:

首先,应用端执行传参后,JS端将指定参数传入开发板端,开发板端在主线程中可获取JS传入的JSIValue参数。开发板端,将该获取的JSIValue参数转化为C/C++类型。初始化JSIValue数据,该数据用来保存Work线程返回给js的数据。

然后,为该work线程创建异步工作项,并将该异步工作项加入到消息队列,等待调度。其中,work线程被调度的时候,work线程执行业务逻辑计算结果,将结果写入JSIValue数据。

最后,work线程执行完成之后,通知EventLoop线程,EventLoop线程调用回调函数SuccessCallBack,将该JSIValue结果返回给JS端。

快速上手

准备硬件环境

欧智通BES2600/V200Z-R开发板 *1;

MQ5燃气检测传感器*1

正常工作无线路由一台(请保证预设 热点名称:test_wifi 密码:12345678 ; 是否能连接互联网均可)

硬件连线图:

准备开发环境

开发基础环境由 windows 工作台和 Linux 编译服务器组成。windows 工作台可以通过 samba 服务或 ssh 方式访问 Linux编译服务器。其中 windows 工作台用来烧录和代码编辑,Linux 编译服务器用来编译 OpenHarmony 代码,为了简化步骤,Linux 编译服务器推荐安装 Ubuntu20.04。

安装必备软件

安装和配置Python3
  1. 打开Linux终端。

  2. 输入如下命令,查看python版本号,需要使用python3.7以上版本,否则参考 系统基础环境搭建

    python3 --version
    
  3. 安装并升级Python包管理工具(pip3)。

    sudo apt-get install python3-setuptools python3-pip -y
    sudo pip3 install --upgrade pip
    
  4. 设置pip的国内镜像

    pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple requests
    

安装交叉编译环境

在Linux编译服务器上搭建好基础开发环境后,需要安装OpenHarmony 编译欧智通BES2600平台特有的开发环境。

安装必备库文件和工具
sudo apt-get install -y build-essential gcc g++ make zlib* libffi-dev git git-lfs python
安装编译工具链arm-none-eabi-gcc
  1. 打开Linux终端。

  2. 下载arm-none-eabi-gcc编译工具。

  3. 安装arm-none-eabi-gcc

解压 gcc-arm-none-eabi-10.3-2021.10-x86_64-linux.tar.bz2 安装包至~/toolchain/路径下。

   mkdir -p ~/toolchain/
   tar -jxvf gcc-arm-none-eabi-10.3-2021.10-x86_64-linux.tar.bz2 -C ~/toolchain/

设置环境变量。

   vim ~/.bashrc

将以下命令拷贝到.bashrc文件的最后一行,保存并退出。

   export PATH=~/toolchain/gcc-arm-none-eabi-10.3-2021.10/bin:$PATH

生效环境变量。

   source ~/.bashrc
  1. 在命令行中输入如下命令,如果能正确显示编译器版本号,表明编译器安装成功。

    arm-none-eabi-gcc -v
    

准备工程

配置git

  • 提前注册准备码云gitee账号。
  • 生成/添加SSH密钥:生成密钥 使用gitee账号绑定的邮箱生成密钥对

    ssh-keygen -t ed25519 -C "xxxxx@xxxxx.com"
    
  • 查看生成的密钥

    cat ~/.ssh/id_ed25519.pub
    
  • 复制生成后的 ssh key,返回gitee个人主页,通过主页 「个人设置」->「安全设置」->「SSH 公钥」 ,将生成的“SSH密钥”添加到仓库中。

  • 配置git用户信息

    git config --global user.name "yourname"
    git config --global user.email "your-email-address"
    git config --global credential.helper store
    

准备repo

1)下载repo工具
mkdir ~/bin
curl https://gitee.com/oschina/repo/raw/fork_flow/repo-py3 > ~/bin/repo
chmod a+x ~/bin/repo

2)设置环境变量并生效
vim ~/.bashrc
export PATH=~/bin:$PATH
source ~/.bashrc 

准备系统源码

#特别注意:请下载OpenHarmony 3.1 Release 版本代码
mkdir ~/openharmony
cd ~/openharmony
repo init -u git@gitee.com:openharmony/manifest.git -b OpenHarmony-3.1-Release --no-repo-verify
repo sync -c
repo forall -c 'git lfs pull'

注意:

1.权限问题请参考生成/添加SSH公钥

2.若在已安装python3.8后,执行repo init 时,仍显示如下错误:

/usr/bin/env: ‘python’: No such file or directory

执行如下命令后,进行重试:

sudo ln -s /usr/bin/python3.8 /usr/bin/python

安装hb

  1. 输入如下命令确认hb是否为version 0.4.4 版本以上

    hb -v
    

a. 若提示如下内容,则表示未安装可以从第2步开始操作。

   bash: /home/***/.local/bin/hb: No such file or directory

b.若提示如下内容,需要先卸载该版本,然后再执行第2步操作步骤。

   [OHOS INFO] hb version 0.4.3

卸载命令:

   pip3 uninstall ohos-build
  1. 运行如下命令安装hb

    pip3 install build/lite   // 该命令需在OpenHarmony源码根目录下执行
    
  2. 设置环境变量

      vim ~/.bashrc
    

    将以下命令拷贝到.bashrc文件的最后一行,保存并退出。

      export PATH=~/.local/bin:$PATH
    

    执行如下命令更新环境变量。

      source ~/.bashrc
    
  3. 再次执行”hb -v“,有以下版本显示则表示安装的hb 0.4.4 以上版本正确。

      [OHOS INFO] hb version 0.4.6
    

准备设备侧应用代码

  1. 代码拷贝

smart_safe_kitchen-gas_detection源码拷贝

   cd ~
   git clone git@gitee.com:openharmony-sig/knowledge_demo_smart_home.git 
   mkdir ~/openharmony/vendor/team_x
   cp -rfa ~/knowledge_demo_smart_home/dev/team_x/MiniSystemApplicationDevelopment_03_GasDetectionJSI_Device  ~/openharmony/vendor/team_x

common库拷贝

   cp -rfa ~/knowledge_demo_smart_home/dev/team_x/common ~/openharmony/vendor/team_x
  1. communicationkit相关修改

参考下方代码修改foundation/ace/ace_engine_lite/frameworks/module_manager/ohos_module_config.h

diff --git a/frameworks/module_manager/ohos_module_config.h b/frameworks/module_manager/ohos_module_config.h
index f8eb744..d0cc5d2 100644
--- a/frameworks/module_manager/ohos_module_config.h
+++ b/frameworks/module_manager/ohos_module_config.h
@@ -45,6 +45,7 @@ extern void InitDialogModule(JSIValue exports);
 #if (FEATURE_MODULE_STORAGE == 1)
 extern void InitNativeApiFs(JSIValue exports);
 extern void InitNativeApiKv(JSIValue exports);
+extern void InitNativeApiCommunicationKit(JSIValue exports);
 #endif

 #if (FEATURE_MODULE_DEVICE == 1)
@@ -102,6 +103,7 @@ const Module OHOS_MODULES[] = {
 #if (FEATURE_MODULE_STORAGE == 1)
     {"file", InitNativeApiFs},
     {"storage", InitNativeApiKv},
+    {"CommunicationKit", InitNativeApiCommunicationKit},
 #endif
 #if (FEATURE_MODULE_DEVICE == 1)
     {"device", InitDeviceModule},
  1. hdf配置文件修改

参考下方代码修改device/board/fnlink/shields/v200zr-evb-t1/v200zr-evb-t1.hcs

diff --git a/shields/v200zr-evb-t1/v200zr-evb-t1.hcs b/shields/v200zr-evb-t1/v200zr-evb-t1.hcs
index 44212eb..4fc99da 100644
--- a/shields/v200zr-evb-t1/v200zr-evb-t1.hcs
+++ b/shields/v200zr-evb-t1/v200zr-evb-t1.hcs
@@ -17,12 +17,17 @@ root {
     platform {
         gpio_config {
             match_attr = "gpio_config";
-            pin = [0, 1];
+            pin = [0, 1, 2];
             // touch_ztw523: TSP_RST - GPIO12, TSP_INT-GPIO27
             // touch_fts: TSP_RST - GPIO05, TSP_INT-GPIO27
-            realPin = [5, 27];
-            config = [5, 2];
-            pinNum = 2;
+            realPin = [5, 27, 11];
+            config = [5, 2, 5];
+            pinNum = 3;
         }
         i2c_config {
             i2c0 {
  1. flash_size 配置项确认

如果V200Z-R 开发板上相关 版本编号丝印为"V200Z-R EVB V1.0", 则在如下代码中配置flash_size选项为16,如果相关丝印编号为"V200Z-R EVB V2.0" , 则保持默认的flash_size = 32不变。

   device/board/fnlink/v200zr/liteos_m/config.gni
   flash_size = 16 
  1. JS应用代码更新(可选)

本步骤为可选章节,忽略本节内容不影响智能通风设备的的展示和运行,如果需要对相关JS 应用做修改,请参考智能窗户JS 应用开发文档,应用修改完成后,再次编译此应用(应用代码地址)。如下图所示:

image-20220418170939198

编译完毕后,hap包所在路径为:MiniSystemApplicationDevelopment_03_GasDetectionJSI\entry\build\outputs\hap\debug\entry-debug-lite-unsigned.hap。

将entry-debug-lite-unsigned.hap修改后缀为zip并解压。打开解压后的目录:entry-debug-lite-unsigned/assets/js/default,如图:

image-20220418160345392

将该目录中除app.js.map外的文件全部拷贝到OpenHarmonySDK中的: vendor/team_x/MiniSystemApplicationDevelopment_03_GasDetectionJSI_Device/fs/data/data/js 目录下。如图:

image-20220418160827027

工程效果

整合并修改完成后的代码目录结构如下图:

image-20220418155207947

编译

进入到OpenHarmony系统源码根目录下,输入hb set命令即可看到我们的应用,选择并确认即可。

cd ~/openharmony
hb set  // 如果是第一次编译,Input code path 命令行中键入"./" 指定OpenHarmony工程编译根目录后回车。

如下图所示,使用键盘上下键选中智能燃气检测系统 “MiniSystemApplicationDevelopment_03_GasDetectionJSI_Device”(注:工程名字根据实际要编译的工程来):

image-20220418163423594

hb build // 如果需要全量编译,可以添加-f 选项

出现"build success"字样,则表示编译生成固件成功,如下图所示:

image-20220418171243614

安装

因为欧智通BES2600/V200Z-R 开发板的烧录程序是包含在对应out文件夹对应product目录下的,无需使用额外的烧录工具,在安装了相应驱动文件后,执行烧录可执行文件即可,下面是具体的操作步骤:

1.安装CP2102驱动,解压后双击与自己window 版本相匹配的可执行文件,并按相关提示安装驱动文件即可;

2.查看串口com号

鼠标右键点击PC右下角,打开:“设备管理器(M)”(注: 打开设备管理器前,请确保CP210x串口驱动是否安装)搜索 “端口 -> USB SERIAL Port(COM10*)",需要记住COM*,每台设备的不一样,如图:

(注:假如端口没显示,请拔掉usb口再插上或更换usb线)

image-20220418173228063

3.打开wifi烧录工具

固件编译完成以后拷贝~/openharmony/out/v200zr/MiniSystemApplicationDevelopment_03_GasDetectionJSI_Device/write_flash_gui文件夹到windows下(或者利用samba服务直接访问该目录),并双击可执行文件Wifi_download_main.exe,如图:

image-20220418171650913

4.串口选择

  • 点击工具上的文件夹图标

  • 选择List按钮

  • 选择对应的com口,点击“OK”

  • 勾选需要烧录的串口, 并点击开始按钮

image-20220418173510927

5.在开发板上点击reset按键,或者重新上电。

6.进入烧录状态,如图:

image-20220418173948845

7.烧录成功,如图:

image-20220418174029399

​ 注意:固件烧录完成后需将烧录窗口关闭,再按下设备Reset键设备才能启动。如果未将烧录窗口关闭,设备会再次进行烧写状态。

操作体验

  1. 将燃气检测设备及其相应的开发板上电,确认两个设备应用启动正常和操作正常;
  2. 开发板端通过燃气浓度传感器获取的燃气浓度数据就会发送到到JS端动态显示;
  3. JS端设置的燃气浓度阈值也可以发送到开发板端,当开发板端检测到燃气浓度超过该阈值,就触发告警; 如图:

gas_detection

参考资料