Microduck-build-tutorial README

The project's README from github.com/AI-FanGe/Microduck-build-tutorial. As one markdown file: README.md.

Microduck

Microduck 结构爆炸图

Microduck 人机互动

Microduck 实机行走

Microduck 是一个小型双足机器人项目,包含两部分:

本 README 面向装机和第一次运行:准备硬件、接线、刷写 microduck.img.xz、初始化 Wi-Fi、SSH 登录、运行模型,以及后续更新代码。3D打印的文件在项目中。

视频教程:https://www.youtube.com/watch?v=Vep8AjoCnEM

致谢

感谢开源项目 microban 和 microduck。本项目的机械结构、部署思路、仿真训练和实机行走流程都受益于这些开源工作。

项目状态

当前发布镜像已经内置:

当前预构建镜像:

BOM

下面是组装一台 Microduck 的主要物料。价格会随地区、采购渠道和批量变化,仅用于估算。

类别 物料 数量 说明
控制板 Raspberry Pi Zero 2 W 1 运行控制程序、蓝牙手柄、Wi-Fi 和 SSH。
舵机控制板 ROBOTIS OpenRB-150 1 通过 USB 连接 Raspberry Pi,负责和 XL330 舵机总线通信。代码会优先自动查找 /dev/serial/by-id/usb-ROBOTIS_OpenRB-150_*。
舵机 Dynamixel XL330-M288-T 14 当前行走代码使用 14 个舵机:双腿 10 个,头/颈 4 个。若安装嘴部舵机,可使用 ID 15,但当前行走模型不依赖它。
电池 成品 6V 可充电电池 1 当前硬件直接使用成品 6V 电池包供电,不使用两节 18650 自制电池组。请确认电池能提供足够瞬时电流。
开关 电源开关 1 控制机器人主电源。
存储 16GB 或更大 microSD 卡 1 推荐使用质量稳定的新卡。镜像刷写后首次启动会自动扩展分区。
IMU BNO080/BNO085/BNO086 模块 1 通过 I2C 读取姿态,代码会自动探测常见地址。
结构件 3D 打印件 1 套 使用 microduck/cad/ 中的模型打印。推荐 PLA。
螺丝 M2/M2.5 自攻螺丝 若干 舵机固定、舵盘固定、结构件连接。建议多备。
线材 Dynamixel 3-pin 线 若干 舵机串联、电源连接、分线。

舵机 ID

控制代码期望的 ID 映射如下。烧录镜像之前或第一次运行之前,应先用 Dynamixel Wizard 设置好每个舵机。

ID 名称 位置
1 right_ankle 右踝
2 right_knee 右膝
3 right_hip_pitch 右髋俯仰
4 right_hip_roll 右髋横滚
5 right_hip_yaw 右髋偏航
6 left_ankle 左踝
7 left_knee 左膝
8 left_hip_pitch 左髋俯仰
9 left_hip_roll 左髋横滚
10 left_hip_yaw 左髋偏航
11 head_pitch 头部俯仰
12 neck_pitch 颈部俯仰
13 head_yaw 头部偏航
14 head_roll 头部横滚
15 mouth 可选嘴部舵机,当前行走策略不使用

Dynamixel Wizard 推荐参数:

接线图

电源接线

电源链路如下:

flowchart LR
    BAT[成品 6V 可充电电池] --> SW[电源开关]
    SW --> OPENRB[OpenRB-150 电源输入]
    OPENRB --> BUS[XL330 舵机总线]
    PI[Raspberry Pi Zero 2 W] -->|USB 数据线| OPENRB
    BAT --> REG[5V 稳压/USB 供电]
    REG --> PI

检查要点:

舵机总线

XL330 使用 3-pin 串联总线。OpenRB-150 接出后可通过分线分到左右腿和头部。

flowchart TD
    OPENRB[OpenRB-150 Dynamixel Port]
    OPENRB --> SPLIT[分线]
    SPLIT --> R5[右腿链: ID 5 -> 4 -> 3 -> 2 -> 1]
    SPLIT --> L10[左腿链: ID 10 -> 9 -> 8 -> 7 -> 6]
    SPLIT --> H12[头颈链: ID 12 -> 11 -> 13 -> 14]

注意:

IMU 接线

BNO08x 模块走 I2C:

IMU 引脚 Raspberry Pi / Hat
VIN / 3V3 3.3V,按模块标识选择
GND GND
SDA GPIO2 / I2C SDA
SCL GPIO3 / I2C SCL

软件默认使用 I2C bus 1,会自动寻找 BNO08x 常见地址。安装方向由 IMU_MOUNT_QUAT 配置,已经和当前行走模型匹配。

使用 microduck.img.xz

1. 校验镜像

下载或拷贝镜像后,建议先校验:

sha256sum microduck.img.xz

应与发布页面或上文给出的 SHA256 一致。

2. 刷写 SD 卡

推荐使用 Raspberry Pi Imager:

  1. 插入 microSD 卡。
  2. 打开 Raspberry Pi Imager。
  3. Choose Device 选择 Raspberry Pi Zero 2 W。
  4. Choose OS 选择 Use custom,选中 microduck.img.xz。
  5. Choose Storage 选择目标 microSD 卡。
  6. 如果提示是否应用 OS customization,选择 No。
  7. 点击 Write,等待写入和验证完成。

Linux 命令行也可以刷写,但要非常确认设备名:

lsblk
xzcat microduck.img.xz | sudo dd of=/dev/sdX bs=4M status=progress conv=fsync

把 /dev/sdX 换成你的 SD 卡设备,不要写成电脑硬盘。

3. 初始化 Wi-Fi

两种方法任选其一。Pi Zero 2 W 只支持 2.4GHz Wi-Fi,不要使用纯 5GHz 网络。

方法 1:在电脑上编辑 SD 卡

刷写完成后,拔下再插回 SD 卡。Ubuntu 通常会挂载出两个分区:

编辑:

sudo nano /media/$USER/bootfs/network-config

内容类似:

network:
  version: 2
  ethernets:
    eth0:
      dhcp4: true
      dhcp6: true
      optional: true
  wifis:
    wlan0:
      dhcp4: true
      regulatory-domain: "<YOUR_COUNTRY_CODE>"
      access-points:
        "<YOUR_WIFI_NAME>":
          password: "<YOUR_WIFI_PASSWORD>"
      optional: true

把三处占位符改掉:

可配置多个 Wi-Fi:

      access-points:
        "HomeWifi":
          password: "home-password"
        "PhoneHotspot":
          password: "hotspot-password"

保存后安全弹出 SD 卡,插入机器人,打开电源。

方法 2:插上 HDMI 和键盘,在 Pi 上用 nmcli

刷写完成后把 SD 卡插入 Pi,接上 mini HDMI 显示器和 USB 键盘(Zero 需要 OTG 转接头)。镜像是 Raspberry Pi OS Lite,没有桌面,开机后是终端登录。

第一次启动会扩展分区,等待 1 到 3 分钟,不要断电。出现登录提示后:

用户名: user
密码:   password

输入密码时屏幕不会显示字符,直接回车。然后扫描并连接 Wi-Fi,设为开机自动连接:

nmcli device wifi list
sudo nmcli device wifi connect "你的WiFi名字" password "你的WiFi密码"
sudo nmcli con mod "你的WiFi名字" wifi.powersave disable
sudo nmcli con mod "你的WiFi名字" connection.autoconnect yes

检查是否连上、是否自动连接:

nmcli -t -f NAME,TYPE,AUTOCONNECT,DEVICE connection show
hostname -I

AUTOCONNECT 应为 yes,并且已经拿到 IP。之后每次开机都会自动连这个 Wi-Fi。

首次启动

第一次启动会做几件事:

等待 1 到 3 分钟,然后在电脑上测试:

ping microduck.local

如果 .local 解析失败,到路由器后台查看 Pi 的 IP,然后用 IP 登录。

默认登录:

ssh [email protected]

默认密码:

password

第一次登录后建议立刻改密码:

passwd

第一次运行模型

SSH 模式

在电脑上远程登录 Pi。Windows 用 PowerShell,Linux / macOS 用终端:

ssh [email protected]

默认密码是 password。如果提示 REMOTE HOST IDENTIFICATION HAS CHANGED,先清掉旧记录再重连:

ssh-keygen -R microduck.local

登录成功后,把机器人放在稳定平面上或扶住,然后启动控制程序:

cd ~/microduck
PYTHONPATH=src .venv/bin/python src/main.py

启动后程序会:

  1. 打开舵机扭矩。
  2. 平滑回到 neutral pose。
  3. 读取键盘或手柄输入。
  4. 加载 src/agents/walk.onnx 行走策略。

键盘控制:

按键 功能
v 开启/关闭行走
方向键上/下 前进/后退
方向键左/右 左右转向
x 速度归零
i 显示/隐藏 IMU 信息
q 停止控制循环

远程 SSH 运行

电脑和机器人连同一个 2.4GHz Wi-Fi 后,在 Windows PowerShell 或 Linux / macOS 终端执行:

ssh [email protected]

登录后:

cd ~/microduck
PYTHONPATH=src .venv/bin/python src/main.py

停止:按 q。如果程序还在跑,另开一个 SSH 窗口:

ssh [email protected]
cd ~/microduck
PYTHONPATH=src .venv/bin/python src/stop.py

安全关机:

ssh [email protected]
sudo shutdown -h now

不要直接断电。先关机,等 10 到 15 秒,再关闭电源开关。

手柄模式

配对蓝牙手柄

SSH 到 Pi 后:

bluetoothctl

在 bluetoothctl 里执行:

power on
agent on
scan on
pair XX:XX:XX:XX:XX:XX
trust XX:XX:XX:XX:XX:XX
connect XX:XX:XX:XX:XX:XX
scan off
quit

把 XX:XX:XX:XX:XX:XX 换成扫描到的手柄 MAC 地址。

无头运行

镜像里已经启用无头手柄服务。开机后:

操作 功能
按住 START 2 秒 启动控制循环
A 开启/关闭行走
左摇杆 前后/左右速度
右摇杆左右 原地或行进中转向
B 停止控制循环
同时按住左右扳机 2 秒 安全关机

手柄连接时,服务会关闭 Wi-Fi 以改善 2.4GHz 蓝牙稳定性。需要 SSH 时,先关闭手柄,Wi-Fi 会自动恢复。

常用命令

在开发电脑的 microduck/ 目录下:

命令 说明
make sync 同步本地部署代码到 Pi 的 ~/microduck。
make setup 同步代码并在 Pi 上执行 uv sync --frozen。改依赖后使用。
make run 同步并启动控制循环。
make stop 停止控制循环。
make shutdown 安全关闭 Pi。
make imu 查看 IMU/gyro 数据。
make voltage 查看舵机电压。
make voltage ID=2 查看指定舵机电压。
make gamepad-headless-enable 安装并启用无头手柄服务。
make gamepad-headless-disable 禁用无头手柄服务。

更新模型

训练仓 mjlab_microduck/ 导出的 ONNX 模型应放到:

microduck/src/agents/walk.onnx

更新后同步:

cd microduck
make sync

下一次运行会加载新的 walk.onnx。

重新制作发布镜像

当 Pi 上的系统、依赖、服务和模型都确认可用后,可以把这张 SD 卡做成新的 microduck.img.xz。

推荐流程:

  1. 先用当前 SD 卡实机测试 make run 或手柄无头运行。
  2. 关机,把 SD 卡插回电脑。
  3. 克隆整张卡到本地 .img 文件。
  4. 只在镜像副本里清理敏感信息:
    • Wi-Fi 配置。
    • SSH host keys。
    • 用户 SSH key。
    • /etc/machine-id。
    • cloud-init 状态。
    • shell history、日志、apt 缓存。
  5. 重置 bootfs/network-config 为占位模板。
  6. 确认 ~/microduck/src/agents/walk.onnx、.venv、microduck-gamepad.service 都存在。
  7. 用 PiShrink 压缩生成 microduck.img.xz。
  8. 计算 SHA256,并把校验值记录到 README 或 Release 说明里。

本仓库已有详细步骤:

microduck/docs/dev/clone_sd.md

目录结构

.
├── README.md
├── microduck/
│   ├── Makefile
│   ├── src/
│   │   ├── main.py
│   │   ├── scheduler.py
│   │   ├── robot_controller.py
│   │   ├── imu_reader.py
│   │   ├── agents/walk.onnx
│   │   └── moves/walk.py
│   ├── systemd/
│   └── docs/
└── mjlab_microduck/
    ├── src/mjlab_microduck/
    └── logs/

故障排查

找不到 microduck.local

先等 1 到 3 分钟。仍找不到时:

SSH 提示 host key changed

发布镜像首次启动会重新生成 SSH host keys。如果同一台电脑以前连过另一张卡,清理本机记录:

ssh-keygen -R microduck.local
ssh-keygen -R <IP>

舵机不动或通信错误

检查:

手柄连接后 SSH 断开

这是无头模式的设计:手柄连接后会关闭 Wi-Fi,提升蓝牙稳定性。关闭手柄后 Wi-Fi 会恢复。

机器人一启动就容易倒

先手扶机器人运行,确认:

安全提示


Microduck (English)

Microduck exploded view

Microduck human-robot interaction

Microduck walking

Microduck is a compact biped robot project. This repository presents one practical hardware and software setup for running an ONNX reinforcement learning walking policy on real Dynamixel XL330 servos.

The project contains two main parts:

This README covers the full first-time workflow: hardware, wiring, flashing microduck.img.xz, Wi-Fi setup, first SSH login, first run, day-to-day usage, and rebuilding a release image.

Acknowledgements

Thanks to the open-source projects microban and microduck. This project benefits from their mechanical design, deployment ideas, simulation training work, and real-robot walking pipeline.

Project Status

The current release image includes:

Current prebuilt image:

SHA256:

096885dc32fb5b1db2ad69ba6bea868d8ab988f2b47c0d884eb63ba0dfdcb5c4

BOM

The following is the main bill of materials for building one Microduck. Prices vary by region, supplier, and quantity, so treat them as estimates.

Category Part Qty Notes
Main controller Raspberry Pi Zero 2 W 1 Runs the control program, Bluetooth gamepad, Wi-Fi, and SSH.
Servo controller ROBOTIS OpenRB-150 1 Connected to the Raspberry Pi over USB. It communicates with the XL330 servo bus. The code first looks for /dev/serial/by-id/usb-ROBOTIS_OpenRB-150_*.
Servos Dynamixel XL330-M288-T 14 The current walking code uses 14 servos: 10 for the legs and 4 for the head/neck. An optional mouth servo can use ID 15, but the walking policy does not depend on it.
Battery Ready-made 6V rechargeable battery 1 This hardware setup uses a ready-made 6V battery pack, not a custom two-cell pack. Make sure the battery can provide enough peak current.
Switch Power switch 1 Main power switch for the robot.
Storage 16GB or larger microSD card 1 Use a reliable new card. The image expands the filesystem on first boot.
IMU BNO080/BNO085/BNO086 module 1 Read over I2C. The code auto-detects common BNO08x addresses.
Mechanical parts 3D-printed parts 1 set Print from the models under microduck/cad/. PLA is recommended.
Screws M2/M2.5 self-tapping screws Several Used for servo mounting, horn mounting, and structural assembly. Keep extras.
Bearings/shims POM shims and steel shims Several Low-cost rotational support.
Cables Dynamixel 3-pin cables, JST wires, power connectors Several Servo daisy chains, power wiring, and splitters.
Setup tools Dynamixel U2D2 + U2D2 Power Hub 1 set Used to configure servo IDs, baud rate, and parameters. One set can be shared across multiple robots.

Recommended extras:

Servo IDs

The deployment code expects the following ID mapping. Configure every servo with Dynamixel Wizard before the

Microduck-build-tutorial (AI-FanGe/Microduck-build-tutorial)

Searching Database…

Что это?Microduck — это туториал по сборке и кодовая база компактного двуногого робота: код развёртывания для Raspberry Pi Zero 2 W, управляющий сервоприводами Dynamixel по походке, выученной обучением с подкреплением в формате ONNX, плюс среда обучения на базе MuJoCo/MjLab для создания этой походки.
Это готовый набор робота или гайд по самостоятельной сборке?Это гайд по самостоятельной сборке: вы сами закупаете детали по списку материалов, печатаете конструктив на 3D-принтере, соединяете всё проводами, затем записываете готовый образ Raspberry Pi OS и запускаете приложенный код развёртывания.
Как заставить робота пойти в первый раз?Запишите microduck.img.xz на microSD-карту через Raspberry Pi Imager, настройте Wi-Fi (через network-config на SD-карте или nmcli), зайдите на Pi по SSH, затем запустите управляющую программу: она подаст питание на сервоприводы, вернёт робота в нейтральную позу и загрузит src/agents/walk.onnx.
Какое железо нужно для сборки?Raspberry Pi Zero 2 W, контроллер сервоприводов ROBOTIS OpenRB-150, 14 сервоприводов Dynamixel XL330-M288-T, готовый аккумулятор на 6 В, модуль IMU BNO08x, microSD-карта от 16 ГБ и напечатанные на 3D-принтере конструктивные детали из microduck/cad/.
Что главное может пойти не так при первом запуске?При первом подъёме и ходьбе робота нужно физически придерживать; Pi Zero 2 W поддерживает только Wi-Fi 2,4 ГГц (чистые сети 5 ГГц не подходят), а подключение Bluetooth-геймпада отключает Wi-Fi ради стабильности соединения.
Как управлять роботом, когда он уже работает?Управлять можно из SSH-сессии клавишами (v — идти, стрелки — двигаться/поворачивать, q — стоп) или подключить Bluetooth-геймпад для управления без экрана: цикл ходьбы стартует нажатием кнопки.
Как обучить или обновить политику походки?Используйте среду обучения с подкреплением на базе MuJoCo в mjlabmicroduck/, чтобы обучить и экспортировать новый файл walk.onnx, затем скопируйте его в ~/microduck/src/agents/walk.onnx на Pi и синхронизируйте командой „make sync“.
Можно собрать свой релизный образ после кастомизации робота?Да, в README описан полный процесс: протестировать на текущей SD-карте, склонировать её в файл .img, вычистить конфиги Wi-Fi, SSH-ключи хоста и machine-id, затем сжать через PiShrink в новый microduck.img.xz.
Какие команды обычно нужны в повседневной разработке?Из каталога microduck/ на вашей dev-машине: „make sync“ отправляет код на Pi, „make setup“ дополнительно выполняет uv sync, „make run“ запускает контроллер ходьбы, „make stop“ его останавливает, а „make shutdown“ безопасно выключает Pi.
Creator
AI-FanGe
Size
34.6 MB
Stars
1.3K
Age
1mo
Commits · 90 Days