【FFH】小熊派添加自定义JS API接口流程（以点亮LED为例）原创精华

Wait_Aurora

发布于 2022-2-13 09:42

浏览

4收藏

一、前言

之前我们开发了小熊派的LED灯驱动，并且编写了相应的代码调用自己的开发驱动，但是自己写的代码只能在终端以命令的形式调用，显然这样十分的不太友好。假设小熊派是我们的一个智能设备，这个LED是我们的手电筒，通过命令行的形式打开手电筒肯定不是我们所期待的，我们更希望能够在图像界面上点一个按钮从而打开我们的手电筒，而目前OpenHarmony大多数采用JS开发应用，如果我们想要在图形界面上打开我们的手电筒，就需要自己定义一个JS的API接口来调用我们的LED。本文便介绍了如何自定义JS API从而调用自己开发的驱动。

二、流程总览

添加JS API接口–>编写接口代码–>配置HDF头文件路径–>添加编译依赖

三、添加JS API接口

打开文件foundation\ace\ace_engine_lite\frameworks\src\core\modules\app_module.h，在32行处添加如下代码

static JSIValue ToggleLed(const JSIValue thisVal, const JSIValue* args, uint8_t argsNum);
1.

如图所示
【FFH】小熊派添加自定义JS API接口流程（以点亮LED为例）-鸿蒙开发者社区

在65行处添加如下代码

JSI::SetModuleAPI(exports, "ledcontrol", AppModule::ToggleLed);
1.

【FFH】小熊派添加自定义JS API接口流程（以点亮LED为例）-鸿蒙开发者社区

四、编写对应的驱动代码

打开foundation\ace\ace_engine_lite\frameworks\src\core\modules\app_module.cpp文件，需要在两个位置添加我们自己API的代码

4.1添加头文件

在头文件导入处添加如下头文件

#include "hdf_sbuf.h"
#include "hdf_io_service_if.h"

#define LED_WRITE_READ 1
#define LED_SERVICE "hdf_led"
1.
2.
3.
4.
5.

如图所示
【FFH】小熊派添加自定义JS API接口流程（以点亮LED为例）-鸿蒙开发者社区

4.2添加API的代码

在适当位置加入以下代码，建议在JSIValue AppModule::GetInfo函数之前

static int OnDevEventReceived(void *priv, uint32_t id, struct HdfSBuf *data)
{
    uint32_t value;
    HdfSbufReadUint32(data, &value);
    HILOG_ERROR(HILOG_MODULE_ACE,"%s: dev event received: %u %u\n", (char *)priv, id, value);

    return HDF_SUCCESS;
}

static int GpioWriteRead(struct HdfIoService *serv, int32_t eventData, int32_t *val)
{
    int ret = HDF_FAILURE;
    struct HdfSBuf *data = HdfSBufObtainDefaultSize();
    struct HdfSBuf *reply = HdfSBufObtainDefaultSize();

    if (data == NULL || reply == NULL) {
        HILOG_ERROR(HILOG_MODULE_ACE,"fail to obtain sbuf data\n");
        return ret;
    }

    if (!HdfSbufWriteUint8(data, (uint8_t)eventData))
    {
        HILOG_ERROR(HILOG_MODULE_ACE,"fail to write sbuf\n");
        HdfSBufRecycle(data);
        HdfSBufRecycle(reply);
        return ret;
    }

    ret = serv->dispatcher->Dispatch(&serv->object, LED_WRITE_READ, data, reply);
    if (ret != HDF_SUCCESS)
    {
        HILOG_ERROR(HILOG_MODULE_ACE,"fail to send service call\n");
        HdfSBufRecycle(data);
        HdfSBufRecycle(reply);
        return ret;
    }
    if (!HdfSbufReadInt32(reply, val))
    {
        HILOG_ERROR(HILOG_MODULE_ACE,"fail to get service call reply\n");
        ret = HDF_ERR_INVALID_OBJECT;
        HdfSBufRecycle(data);
        HdfSBufRecycle(reply);
        return ret;
    }
    HILOG_ERROR(HILOG_MODULE_ACE,"Get reply is: %d\n", val);

    HdfSBufRecycle(data);
    HdfSBufRecycle(reply);
    return ret;
}

JSIValue AppModule::ToggleLed(const JSIValue thisVal, const JSIValue *args, uint8_t argsNum)
{
    HILOG_ERROR(HILOG_MODULE_ACE, "led button pressed.");

    struct HdfIoService *serv = HdfIoServiceBind(LED_SERVICE);
    if (serv == NULL)
    {
        HILOG_ERROR(HILOG_MODULE_ACE,"fail to get service2 %s\n", LED_SERVICE);
        return JSI::CreateUndefined();
    }

    if ((args == nullptr) || (argsNum == 0) || (JSI::ValueIsUndefined(args[0]))) {
        return JSI::CreateUndefined();
    }

    JSIValue success = JSI::GetNamedProperty(args[0], CB_SUCCESS);
    JSIValue fail = JSI::GetNamedProperty(args[0], CB_FAIL);
    JSIValue complete = JSI::GetNamedProperty(args[0], CB_COMPLETE);

    int32_t num = (int32_t)JSI::GetNumberProperty(args[0], "code");

    int32_t replyData = 0;

    if (GpioWriteRead(serv, num, &replyData))
    {
        HILOG_ERROR(HILOG_MODULE_ACE,"fail to send event\n");
        JSI::CallFunction(fail, thisVal, nullptr, 0);
        JSI::CallFunction(complete, thisVal, nullptr, 0);
        JSI::ReleaseValueList(success, fail, complete);
        return JSI::CreateUndefined();
    }

    JSIValue result = JSI::CreateObject();
    JSI::SetNumberProperty(result, "led_status", replyData);

    JSIValue argv[ARGC_ONE] = {result};
    JSI::CallFunction(success, thisVal, argv, ARGC_ONE);
    JSI::CallFunction(complete, thisVal, nullptr, 0);
    JSI::ReleaseValueList(success, fail, complete, result);

    HdfIoServiceRecycle(serv);

    return JSI::CreateUndefined();
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70.
71.
72.
73.
74.
75.
76.
77.
78.
79.
80.
81.
82.
83.
84.
85.
86.
87.
88.
89.
90.
91.
92.
93.
94.
95.

代码推荐添加位置如图所示
【FFH】小熊派添加自定义JS API接口流程（以点亮LED为例）-鸿蒙开发者社区

五、配置HDF头文件路径

打开foundation\ace\ace_engine_lite\ace_lite.gni文件，在大约80行处添加如下配置

ace_lite_include_dirs += [
    "//drivers/framework/ability/sbuf/include",
    "//drivers/framework/include/core",
    "//drivers/framework/include/utils",
    "//drivers/adapter/uhdf/posix/include",
]
1.
2.
3.
4.
5.
6.

【FFH】小熊派添加自定义JS API接口流程（以点亮LED为例）-鸿蒙开发者社区
![](C:\Users\33124\Desktop\博客素材\小熊派开发JS API\HDF配置.png)

六、添加编译依赖

打开foundation\ace\ace_engine_lite\frameworks\BUILD.gn，在public_deps中添加以下代码

"//drivers/adapter/uhdf/manager:hdf_core",
1.

打开foundation\ace\ace_engine_lite\test\ace_test_config.gni，在extra_deps中添加以下代码

"//drivers/adapter/uhdf/manager:hdf_core",
1.

七、补充

至此接口就开发好了，至于怎么调用，请参考另外一位同学的文章【FFH】小熊派北向通过JS自定义接口调用南向驱动(以点亮LED为例)

©著作权归作者所有，如需转载，请注明出处，否则将追究法律责任

分类

标签

已于2022-2-18 15:23:26修改

4条回复

按时间正序

按时间倒序

红叶亦知秋

自定义总是更炫酷一些，感谢指导

2022-2-14 11:56:12

lrf19930506

我参考上面的教程移植到hi3516dv300-ipcamera_hispark_taurus，ace通过HdfIoServiceBind绑定服务失败，单独写一个测试程序却能成功，版本是openharmony小型系统LTS3.0.2，大神们帮看一下。

ace绑定服务失败，代码段以及日志如下:

#define LED_SERVICE "hdf_led"

JSIValue AppModule::ToggleLed(const JSIValue thisVal, const JSIValue *args, uint8_t argsNum)
{
    HILOG_INFO(HILOG_MODULE_ACE, "Ace ToggleLed%s\n", LED_SERVICE);
    struct HdfIoService *serv = HdfIoServiceBind(LED_SERVICE);
    if (serv == NULL) {
        HILOG_ERROR(HILOG_MODULE_ACE, "fail to get service2 %s\n", LED_SERVICE);
        return JSI::CreateUndefined();
    }
    HdfIoServiceRecycle(serv);
    return JSI::CreateUndefined();
}

#下面是日志
#################################################################
OHOS # 
OHOS # 01-01 00:19:15.459 18 16 I 03900/ACE: Ace ToggleLedhdf_led

01-01 00:19:15.459 18 16 E 02500/hdf_syscall_adapter: HdfIoServiceAdapterObtain: load dev_mgr driver failed
01-01 00:19:15.459 18 16 E 02500/HDF_LOG_TAG: failed to get dev_mgr service
01-01 00:19:15.459 18 16 E 02500/hdf_syscall_adapter: HdfIoServiceAdapterObtain: load hdf_led driver failed
01-01 00:19:15.459 18 16 E 03900/ACE: fail to get service2 hdf_led
OHOS # 1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.

测试程序却可以成功绑定，代码段以及日志：

#define LED_SERVICE "hdf_led"

int main(int argc, char **argv)
{
  int i;
  printf("myled service %s!\r\n", LED_SERVICE);
  /* 获取服务 */
  struct HdfIoService *serv = HdfIoServiceBind(LED_SERVICE);
  if (serv == NULL)
  {
    printf("fail to get service %s!\r\n", LED_SERVICE);
    return HDF_FAILURE;
  }
  for (i = 0; i < argc; i++)
  {
    printf("\r\nArgument %d is %s.\r\n", i, argv[i]);
  }
  SendEvent(serv, atoi(argv[1]));
  HdfIoServiceRecycle(serv);
  printf("exit");
  return HDF_SUCCESS;
}

#下面是日志
#################################################################
OHOS # 
OHOS # ./my_led 0
myled service hdf_led!
Argument 0 is my_led.
Argument 1 is 0.
Get reply is: 0
exit
OHOS #
01-01 00:19:31.643 22 101 E 02500/led_driver: Led driver dispatch
OHOS # 
OHOS # 1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.

2022-3-21 19:44:00

随遇而安的dandelion

代码中用到了很多JSI类的东西，由关于这个类的说明文档吗？很想知道这些代码是怎么写出来的？“渔”在哪里？能把你写出这个代码的学习路径讲一下吗？

2022-5-10 15:26:08

wx5d4ae0a46eeb9 回复了 lrf19930506

我参考上面的教程移植到hi3516dv300-ipcamera_hispark_taurus，ace通过HdfIoServiceBind绑定服务失败，单独写一个测试程序却能成功，版本是openharmony小型系统LTS3.0.2，大神们帮看一下。 ace绑定服务失败，代码段以及日志如下: #define LED_SERVICE "hdf_led" JSIValue AppModule::ToggleLed(const JSIValue thisVal, const JSIValue *args, uint8_t argsNum) { HILOG_INFO(HILOG_MODULE_ACE, "Ace...

遇到了同样问题, 插个眼先

2022-6-28 11:56:52

51CTO

51CTO博客

51CTO学堂

【FFH】小熊派添加自定义JS API接口流程（以点亮LED为例）原创精华

一、前言

二、流程总览

三、添加JS API接口

四、编写对应的驱动代码

4.1添加头文件

4.2添加API的代码

五、配置HDF头文件路径

六、添加编译依赖

七、补充

目录

订阅鸿蒙技术特刊，精选内容抢先看

51CTO

51CTO博客

51CTO学堂

【FFH】小熊派添加自定义JS API接口流程（以点亮LED为例） 原创 精华

一、前言

二、流程总览

三、添加JS API接口

四、编写对应的驱动代码

4.1添加头文件

4.2添加API的代码

五、配置HDF头文件路径

六、添加编译依赖

七、补充

目录

订阅鸿蒙技术特刊，精选内容抢先看

【FFH】小熊派添加自定义JS API接口流程（以点亮LED为例）原创精华