Niryo One 开源项目启动与配置教程

1. 项目的目录结构及介绍

Niryo One 是一个开源项目，用于控制 Niryo 的机械臂。以下是项目的目录结构及简要介绍：

niryo_one/
├── docs/                # 项目文档目录
├── hardware/            # 硬件描述文件和固件
├── install/             # 安装脚本和依赖
├── software/            # 主软件代码
│   ├── api_server/      # API 服务器代码
│   ├── communication/   # 通讯模块代码
│   ├── interfaces/      # 接口模块代码
│   ├── led_manager/     # LED 管理模块代码
│   ├── niryo_one/       # Niryo One 主程序
│   ├── robot Trajectory # 机械臂轨迹规划
│   ├── tools/           # 实用工具代码
│   └── web_app/         # Web 应用程序代码
└── tests/               # 测试代码目录

• docs/：包含项目的文档，如用户手册、开发者文档等。
• hardware/：存放与硬件相关的描述文件和固件。
• install/：安装脚本和项目依赖文件。
• software/：项目的主要软件代码。
  • api_server/：API 服务器，用于处理客户端请求。
  • communication/：通讯模块，负责设备间的通信。
  • interfaces/：接口模块，定义了与其他系统交互的接口。
  • led_manager/：LED 管理模块，用于控制 LED 灯。
  • niryo_one/：Niryo One 主程序，核心控制逻辑。
  • robot Trajectory：机械臂轨迹规划，用于控制机械臂运动。
  • tools/：实用工具，提供了一些辅助功能。
  • web_app/：Web 应用程序，用于交互界面。
• tests/：包含项目的测试代码。

2. 项目的启动文件介绍

项目的启动文件通常位于 software/niryo_one/ 目录下。以下是启动文件的基本介绍：

• main.py：主程序入口文件，负责初始化和启动整个系统。
• run.py：运行脚本，用于启动主程序。

通常情况下，通过以下命令启动项目：

python run.py

3. 项目的配置文件介绍

项目的配置文件通常位于 software/niryo_one/config/ 目录下。以下是配置文件的基本介绍：

• config.json：项目的配置文件，包含各种参数设置，如网络配置、硬件配置等。
• credentials.json：认证文件，包含了敏感信息，如 API 密钥等。

配置文件中可以包含如下内容：

• network：网络配置，如 IP 地址、端口等。
• hardware：硬件配置，如传感器、执行器参数等。
• security：安全配置，如加密密钥、认证信息等。

在启动项目前，确保配置文件中的参数正确无误，以避免运行时出现错误。