JavaScript 轻量级引擎 Elk 使用教程

JavaScript 轻量级引擎 Elk 使用教程

elk A low footprint JavaScript engine for embedded systems 项目地址: https://gitcode.com/gh_mirrors/elk/elk

1. 项目介绍

Elk 是一个专为嵌入式系统设计的轻量级 JavaScript 引擎，它实现了 ES6 的一部分功能。Elk 旨在让开发者能够在用 C/C++ 开发的固件中加入 JavaScript 自定义功能，从而允许用户扩展或定制设备功能。

Elk 引擎的特点包括：

• 跨平台：适用于从 8 位微控制器到 64 位服务器的任何平台。
• 无依赖：可由 ISO C 或 ISO C++ 编译器干净地编译。
• 易于嵌入：只需将 elk.c 和 elk.h 文件复制到你的源代码树中即可。
• 简单的嵌入式 API。
• 不使用 malloc，仅使用指定的内存缓冲区。
• 超小占用：闪存/磁盘上约 20KB，核心虚拟机 RAM 占用约 100 字节。
• 无字节码：直接解释 JS 代码。

2. 项目快速启动

安装

将 Elk 引擎的源文件 elk.c 和 elk.h 复制到你的项目中。

创建 JavaScript 环境

#include "elk.h"

int main() {
    char mem[200];
    struct js *js = js_create(mem, sizeof(mem));
    if (!js) {
        return 1; // 内存不足
    }
    // 使用 JavaScript 代码...
    js_destroy(js);
    return 0;
}

执行 JavaScript 代码

jsval_t result = js_eval(js, "1 + 2 * 3", ~0);
printf("result: %s\n", js_str(js, result)); // 输出结果：7

3. 应用案例和最佳实践

调用 JavaScript 代码

#include "elk.h"

jsval_t sum(struct js *js, jsval_t *args, int nargs) {
    if (nargs != 2) return js_err(js, "2 args expected");
    double a = js_getnum(args[0]);
    double b = js_getnum(args[1]);
    return js_mknum(a + b);
}

int main() {
    // 创建 JavaScript 环境...
    js_set(js, js_glob(js), "sum", js_mkfun(sum));
    jsval_t result = js_eval(js, "sum(3, 4);", ~0);
    printf("result: %s\n", js_str(js, result)); // 输出结果：7
    // 销毁 JavaScript 环境...
}

从 JavaScript 调用 C 函数

在 JavaScript 中调用 C 语言编写的函数。

4. 典型生态项目

由于 Elk 引擎是开源的，它已经被集成到多个生态项目中，例如：

• Esp32JS：一个将 Elk 引擎集成到 ESP32 开发板上的 Arduino草图示例，提供即时的 JavaScript 开发环境。

这些项目展示了如何将 Elk 引擎与不同的硬件和平台集成，为开发者提供更多自定义和扩展的可能性。

elk A low footprint JavaScript engine for embedded systems 项目地址: https://gitcode.com/gh_mirrors/elk/elk