Firmata 技术文档

1. 安装指南

Firmata 是一种用于从宿主机软件与微控制器通信的协议。本指南将帮助您在 Arduino 开发板上安装和使用 Firmata。

安装方式

方式一：使用 Arduino IDE 管理库

1. 打开 Arduino IDE。
2. 导航至：Sketch > Include Library > Manage Libraries。
3. 在搜索框中输入 "Firmata"，然后选择列表中的 "Firmata by Firmata Developers"。
4. 点击 Select version 下拉菜单，选择最新版本（也可以选择安装之前的版本）。
5. 点击 Install。

方式二：克隆源代码

如果您需要贡献代码或使用比最新标签版本更新的版本，您可以克隆 Firmata 的代码库。此方法仅适用于 Arduino 1.6.4 及以上版本。

$ git clone [e-mail]:firmata/arduino.git ~/Documents/Arduino/libraries/Firmata

请根据您的操作系统和 Arduino 默认目录修改以上路径。

方式三：手动更新库（针对 Arduino 1.6.3 或更低版本）

1. 下载最新的 Firmata 发布版本。
2. 将下载的 Firmata 文件夹替换到您的 Arduino 应用程序目录中相应的位置。
3. 重启 Arduino 应用程序，最新版本的 Firmata 将可供使用。

不同操作系统和 Arduino 版本的详细步骤如下：

• Mac OSX：

  • 导航到 Arduino 应用程序。
  • 右键点击应用程序图标并选择 Show Package Contents。
  • 导航到：/Contents/Resources/Java/libraries/，并用最新版本替换现有的 Firmata 文件夹。
  • 重启 Arduino 应用程序。

• Windows：

  • 导航到 c:/Program Files/arduino-1.x/libraries/。
  • 替换现有的 Firmata 文件夹。
  • 重启 Arduino 应用程序。

• Linux：

  • 导航到 ~/arduino-1.x/libraries/。
  • 替换现有的 Firmata 文件夹。
  • 重启 Arduino 应用程序。

请根据实际情况更新路径和 Arduino 版本。

2. 项目使用说明

Firmata 的使用主要分为两种模式：

• 模式一：Arduino 草图的作者使用 Firmata 库提供的各种方法，在 Arduino 设备和宿主机软件之间有选择地发送和接收数据。例如，用户可以使用 Firmata.sendAnalog(analogPin, analogRead(analogPin)) 发送模拟数据到宿主机，或使用 Firmata.sendString(stringToSend) 发送字符串数据。
• 模式二：更常见的模式是，将一个名为 StandardFirmata 的通用草图（或根据需要选择 StandardFirmataPlus 或 StandardFirmataEthernet 等变体）加载到 Arduino 开发板上，然后完全使用宿主机软件与 Arduino 开发板进行交互。

您可以在 Arduino IDE 的 File > Examples > Firmata 中找到 StandardFirmata 示例。

3. 项目 API 使用文档

Firmata 的 API 文档可以帮助您了解如何在宿主机软件中使用各种方法与 Arduino 开发板进行交互。您可以通过以下方式查看 API 文档：

# 请在浏览器中访问以下地址查看文档
https://firmata.github.io/arduino/html/index.html

4. 项目安装方式

请参考上述“安装指南”部分，了解如何在您的 Arduino 开发板上安装 Firmata 项目。