BoneScript 项目技术文档

1. 安装指南

1.1 系统要求

BoneScript 是一个用于嵌入式 Linux 上的物理计算的 node.js 库，主要支持 BeagleBone 系列开发板。为了使用 BoneScript，您需要确保您的系统满足以下要求：

• 使用 BeagleBoard.org 提供的最新 Debian 镜像。
• 确保您的 BeagleBone 开发板已经安装了 node.js。

1.2 安装步骤

BoneScript 已经预装在 BeagleBone 开发板上。如果您需要更新到最新版本，可以按照以下步骤操作：

1. 使用 npm 更新 BoneScript：

   TERM=none sudo npm cache clear
   TERM=none sudo npm install -g --prefix /usr/local --unsafe-perm bonescript
   

2. 更新完成后，重启系统：

   sudo shutdown -r now
   

1.3 额外安装步骤

在某些情况下，您可能需要执行以下额外步骤来配置后台服务和环境变量：

sudo cp bonescript/etc/default/node /etc/default/node
sudo cp bonescript/etc/profile.d/node.sh /etc/profile.d/node.sh
sudo cp bonescript/systemd/* /lib/systemd/system
sudo systemctl enable bonescript.socket
sudo systemctl enable bonescript-autorun.service

2. 项目的使用说明

2.1 项目简介

BoneScript 是一个基于 node.js 的库，旨在简化嵌入式 Linux 上的物理计算任务。它提供了类似于 Arduino 的函数，使用 JavaScript 编写，帮助用户快速创建 GUI 并通过 HTML5/JavaScript 网页进行嵌入式应用的开发。

2.2 启动应用程序

要将应用程序设置为在启动时自动运行，只需将它们放入 /var/lib/cloud9/autorun 文件夹中。移出该文件夹的应用程序将停止运行。请注意，放入该文件夹的应用程序应确保没有 bug，因为调试这些应用程序并不容易。

2.3 示例代码

以下是一个简单的 BoneScript 示例代码，它将 P8_12 引脚的输入值复制到 P8_13 引脚的输出值：

var b = require('bonescript');

b.pinMode('P8_12', b.INPUT);
b.pinMode('P8_13', b.OUTPUT);

setInterval(copyInputToOutput, 100);

function copyInputToOutput() {
    b.digitalRead('P8_12', writeToOutput);
    function writeToOutput(x) {
        b.digitalWrite('P8_13', x.value);
    }
}

3. 项目API使用文档

3.1 系统相关API

• getPlatform([callback])：获取平台信息。
• getEeproms([callback])：获取 EEPROM 信息。
• echo(data, [callback])：返回传入的数据。
• readTextFile(filename, [callback])：读取文本文件。
• writeTextFile(filename, data, [callback])：写入文本文件。
• setDate(date, [callback])：设置系统日期。

3.2 数字和模拟I/O API

• analogRead(pin, [callback])：读取模拟引脚的值。
• analogWrite(pin, value, [freq], [callback])：写入模拟引脚的值。
• attachInterrupt(pin, handler, mode, [callback])：附加中断处理程序。
• detachInterrupt(pin, [callback])：移除中断处理程序。
• digitalRead(pin, [callback])：读取数字引脚的值。
• digitalWrite(pin, value, [callback])：写入数字引脚的值。
• pinMode(pin, direction, [mux], [pullup], [slew], [callback])：设置引脚模式。
• getPinMode(pin, [callback])：获取引脚模式。
• shiftOut(dataPin, clockPin, bitOrder, val, [callback])：移位输出数据。

3.3 串口通信API

• serialOpen(port, options, [callback])：打开串口。
• serialWrite(port, data, [callback])：写入串口数据。
• serialParsers：串口解析器。

3.4 I2C通信API

• i2cOpen(port, address, options, [callback])：打开 I2C 端口。
• i2cScan(port, [callback])：扫描 I2C 设备。
• i2cWriteByte(port, byte, [callback])：写入 I2C 字节。
• i2cWriteBytes(port, command, bytes, [callback])：写入 I2C 字节数组。
• i2cReadByte(port, [callback])：读取 I2C 字节。
• i2cReadBytes(port, command, length, [callback])：读取 I2C 字节数组。
• i2cStream(port, command, length, [callback])：流式读取 I2C 数据。

3.5 机器人控制API

• rcInitialize([callback])：初始化机器人控制。
• rcState([state], [callback])：获取或设置机器人状态。
• rcLED(led, [value], [callback])：控制 LED。
• rcOn(event, [callback])：启用事件处理。
• rcMotor(motor, value, [callback])：控制电机。
• rcServo(option, value, [callback])：控制伺服电机。
• rcBMP([option], [callback])：获取 BMP 传感器数据。
• rcIMU([option], [callback])：获取 IMU 传感器数据。
• rcEncoder(encoder, [value], [callback])：获取或设置编码器值。

4. 项目安装方式

4.1 全局安装

BoneScript 已经预装在 BeagleBone 开发板上。如果您需要更新到最新版本，可以使用 npm 进行全局安装：

TERM=none sudo npm cache clear
TERM=none sudo npm install -g --prefix /usr/local --unsafe-perm bonescript
sudo shutdown -r now

4.2 额外配置

在某些情况下，您可能需要执行以下额外步骤来配置后台服务和环境变量：

sudo cp bonescript/etc/default/node /etc/default/node
sudo cp bonescript/etc/profile.d/node.sh /etc/profile.d/node.sh
sudo cp bonescript/systemd/* /lib/systemd/system
sudo systemctl enable bonescript.socket
sudo systemctl enable bonescript-autorun.service

通过以上步骤，您可以顺利安装并使用 BoneScript 进行嵌入式开发。