diff --git a/docs/Quectel-Pi-H1/en/Applications/README.md b/docs/Quectel-Pi-H1/en/Applications/README.md index 2b543cace568a3c7d92555cd9ef27064b189cdc2..8cad0b92bc90b2f0b877336b2944846591408613 100755 --- a/docs/Quectel-Pi-H1/en/Applications/README.md +++ b/docs/Quectel-Pi-H1/en/Applications/README.md @@ -14,5 +14,6 @@ This chapter introduces methods and guidelines for developing various applicatio - [Qt graphical interface development](./qt_development.md) - [wx graphical interface development](./wx_development.md) - [ROS system installation](./ros_installation.md) +- [OpenClaw Deployment](./openclaw.md) - [Container deployment](./container_deployment.md) - [Open-source projects](./Open-Source-Projects/README.md) diff --git a/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw1.png b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw1.png new file mode 100644 index 0000000000000000000000000000000000000000..538705ae14518d72b98d6025b2268602a8acf1b2 Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw1.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw14.png b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw14.png new file mode 100644 index 0000000000000000000000000000000000000000..6d65491bca638e61a7e3773960f8fd8d8ebe0d52 Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw14.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw15.png b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw15.png new file mode 100644 index 0000000000000000000000000000000000000000..091a200749b528fe94d59a29721cc9f3255220b0 Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw15.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw16.png b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw16.png new file mode 100644 index 0000000000000000000000000000000000000000..b31f797b16e31e17119101cb0810a5e169683afd Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw16.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw17.png b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw17.png new file mode 100644 index 0000000000000000000000000000000000000000..377d1b99a3a2ed3ee43088ff34fe5c324f803b72 Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw17.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw18.png b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw18.png new file mode 100644 index 0000000000000000000000000000000000000000..3d49c8761c533c31c1bfe0ea455ffbfb8bf18392 Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw18.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw19.png b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw19.png new file mode 100644 index 0000000000000000000000000000000000000000..9e7b30be267bc1a45d6248617227fdf83daa33c8 Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw19.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw2.png b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw2.png new file mode 100644 index 0000000000000000000000000000000000000000..f94090b8e5e47e8f4b834b876f7c7fce12dc54aa Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw2.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw20.png b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw20.png new file mode 100644 index 0000000000000000000000000000000000000000..d124c266d9841dbf942e096d74afd34b54ba3a27 Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw20.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw3.png b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw3.png new file mode 100644 index 0000000000000000000000000000000000000000..7adca8bb649d5c93e6ab1d31e4723c38b526b7c1 Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw3.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw5.png b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw5.png new file mode 100644 index 0000000000000000000000000000000000000000..7196fd60fac05a06f550a1eec97bd5fd3a2dd8fe Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/OpenClaw5.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/media/feishu1.png b/docs/Quectel-Pi-H1/en/Applications/media/feishu1.png new file mode 100644 index 0000000000000000000000000000000000000000..e30a51ae2f511f077cca42c48a976425857949e1 Binary files /dev/null and b/docs/Quectel-Pi-H1/en/Applications/media/feishu1.png differ diff --git a/docs/Quectel-Pi-H1/en/Applications/openclaw.md b/docs/Quectel-Pi-H1/en/Applications/openclaw.md new file mode 100644 index 0000000000000000000000000000000000000000..76c21ccdd7b0c5ed10610fcedef9a7a9ba318582 --- /dev/null +++ b/docs/Quectel-Pi-H1/en/Applications/openclaw.md @@ -0,0 +1,212 @@ +# OpenClaw Deployment + +OpenClaw is a lightweight, highly scalable open-source AI Agent scheduling platform designed for low-threshold agent implementation. It enables rapid construction of custom AI agents without complex development, and is perfectly compatible with hardware environments across all scenarios such as edge development boards, AI BOX, and cloud servers. + +Key Features： + +- **Lightweight Deployment**: No complex environment dependencies, simple deployment process, low resource consumption, and compatible with various low-config hardware environments; +- **Highly Scalable Design**: Supports plug-in based expansion, enabling quick access to multiple channels like Feishu to meet functional expansion needs for different scenarios; +- **Full-Scenario Adaptation**: Compatible with various hardware environments including edge development boards, AI BOX, and cloud servers, adapting to different deployment scenarios; +- **Low-Threshold Usage**: No professional development capabilities required. Complete agent construction and debugging through wizard-style configuration and simple command-line operations; + +## Installing OpenClaw + +### Update System Dependencies and Install Required Tools + +Execute the following commands to update the system software sources and install basic tools such as curl, git to prepare for subsequent installation: + +``` +sudo apt update +sudo apt install -y curl git ca-certificates build-essential jq +``` + +### Install Node.js 22 + +OpenClaw officially requires the Node.js runtime environment to be **no lower than** version 22. Execute the following commands to complete the installation: + +``` +curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - +sudo apt install -y nodejs +``` + +After installation, verify that the version meets the requirements: + +``` +node -v # Normal output should be v22.x.x or higher +npm -v # Normal output should be 10.x.x or higher +``` + +### Install OpenClaw + +Install the latest version of OpenClaw globally via npm and verify the installation result: + +``` +sudo npm install -g openclaw@latest +openclaw --version +``` + +> Installation usually takes 5–10 minutes, depending on the download speed of the network environment. + +### Initialize OpenClaw + +After the first installation, the configuration wizard process must be completed; otherwise, OpenClaw cannot run normally. Execute the following command to start the configuration wizard and install the gateway daemon: + +``` +openclaw onboard --install-daemon +``` + +The gateway daemon (launchd/systemd user service) ensures that OpenClaw runs in the background. + +Configuration Wizard Screenshots (For Reference Only) + +1.Enter the installation confirmation interface, select [Yes] and press Enter; + + + +2.In the [Onboarding mode] option, select [QuickStart]; + + + +3.In the [Model/auth provider] option, select [Qwen] and press Enter; + + + +4.Open the specified website to log in to the qwen-code platform and complete identity authentication; + + + +After configuration is complete, restart the gateway to make the configuration take effect: + +``` +openclaw gateway restart +``` + +## Integrate with Feishu + +### Install Feishu Plugin + +Feishu Plugin Repository：https://github.com/m1heng/clawdbot-feishu?tab=readme-ov-file#english + + + +Execute the following command to install the Feishu plugin: + +``` +openclaw plugins install @m1heng-clawd/feishu +``` + +If the plugin is already installed, upgrade to the latest version with the following command: + +``` +openclaw plugins update feishu +``` + +### Create a Feishu Application + +1. Log in to the Feishu Open Platform Developer Background: + +- Feishu (China)：[https://open.feishu.cn/app](https://open.feishu.cn/app?lang=zh-CN) + +- Lark (International Version):https://open.larksuite.com/app + +2. Select to create an **「In-house Enterprise Application」**; +3. Complete basic application information, including application name, application description, etc.; +4. Enter the **「Application Capabilities」** page from the left menu bar, click **「Add Application Capability」**, and enable the **「Bot」** capability; +5. Enter the **「Credentials and Basic Information」** page, record and securely save the application's **AppID** and **App Secret** (required for subsequent plugin configuration). + +### Configure the Plugin + +Execute the following commands in the terminal command line, replace `appId` and `appSecret` in the commands with the actual parameters obtained in the above steps to complete the basic configuration of the Feishu plugin: + +``` +openclaw config set channels.feishu.enabled true --json +openclaw config set channels.feishu.appId "cli_xxxxx" +openclaw config set channels.feishu.appSecret "your_app_secret" +``` + +### Configure Permissions + +Enter the **「Permission Management」** page of the Feishu Open Platform application background, and configure the following permissions for the application (divided into required permissions and optional permissions): + +**Required Permissions** + +| Permission | Scope | Description | +| ---------------------------------- | --------- | ----------------------------------- | +| `im:message` | Messaging | Send and receive messages | +| `im:message.p2p_msg:readonly` | DM | Read direct messages to bot | +| `im:message.group_at_msg:readonly` | Group | Receive @mention messages in groups | +| `im:message:send_as_bot` | Send | Send messages as the bot | +| `im:resource` | Media | Upload and download images/files | + +**Optional Permissions** + +| Permission | Scope | Description | +| ---------------------------- | --------- | ------------------------------------------------------------ | +| `contact:user.base:readonly` | User info | Get basic user info (required to resolve sender display names for speaker attribution) | +| `im:message.group_msg` | Group | Read all group messages (sensitive). Required when you want `requireMention: false` to work for non-@ group messages | +| `im:message:readonly` | Read | Get message history | +| `im:message:update` | Edit | Update/edit sent messages | +| `im:message:recall` | Recall | Recall sent messages | +| `im:message.reactions:read` | Reactions | View message reactions | + +### Configure Events and Callbacks + +In the Feishu Open Platform application background, enter the **「Events and Callbacks」** page and complete the following configurations: + +1. Event Configuration Method + - **Receive events using long connection** — corresponding to `connectionMode: "websocket"` (recommended, no public network address required) + - **Receive events using request address** — corresponding to `connectionMode: "webhook"` (requires a publicly accessible URL) +2. Click **「Add Event Subscription」** and check the following necessary events: + +| Event | Description | +| ------------------------------- | --------------------------- | +| `im.message.receive_v1` | Receive messages (required) | +| `im.message.message_read_v1` | Message read receipts | +| `im.chat.member.bot.added_v1` | Bot added to group | +| `im.chat.member.bot.deleted_v1` | Bot removed from group | + +### Publish and Test + +1.Enter the 「Version Management and Release」 page of the Feishu Open Platform application background; + +2.Create a new version and submit it for release review; + +3.After the release review is approved, the application can be searched in the Feishu client to complete basic testing. + +### User Permission Approval and Exception Handling + +When a Feishu user chats with the bot for the first time, the system will trigger permission verification, and the corresponding Pairing code will be displayed in the chat interface. Execute the following command in the terminal of the device where OpenClaw is deployed to complete user permission approval, after which the user can chat with the bot normally: + +``` +openclaw pairing approve feishu "Pairing code" +``` + +## OpenClaw Function Demonstration + +Execute the `openclaw dashboard` command in the terminal to view the access address of the OpenClaw Web management page. + + + + + +### Open-Source Project Deployment + +1.After completing OpenClaw deployment, refer to the official open-source project deployment [guide document](./Open-Source-Projects/README.md) to complete the deployment configuration of the corresponding Demo environment; + +2.Run the Demo sample program to verify whether the basic functions of the Demo configured through OpenClaw are normal. + + + +Effect Screenshots: + + + +### Control Peripherals + +Send conversation instructions through the OpenClaw Web control page, and after a short wait, the real-time preview screen of the USB camera can be seen on the external display. + + + + + + diff --git a/docs/Quectel-Pi-H1/en/User-Guide/Remote-Access/vnc.md b/docs/Quectel-Pi-H1/en/User-Guide/Remote-Access/vnc.md index 6d12b3a90ed6cb4ff2e704e2b8e78c8d4be11000..585c5a1096eaed8b7755689d7604742b8bc665c3 100644 --- a/docs/Quectel-Pi-H1/en/User-Guide/Remote-Access/vnc.md +++ b/docs/Quectel-Pi-H1/en/User-Guide/Remote-Access/vnc.md @@ -13,6 +13,7 @@ Use the debug serial port or `adb shell` to enter the terminal window and enter ```bash sudo apt update sudo apt install -y xvfb xfce4 x11vnc +sudo apt install --reinstall libdbus-1-3 dbus dbus-x11 ```` - If any options appear during installation, simply press the `Enter` key. diff --git a/docs/Quectel-Pi-H1/en/sidebar.yaml b/docs/Quectel-Pi-H1/en/sidebar.yaml index 7b803be0954d8d10752dad9b2796a7eb4baa5ad6..a1219ca2407d99e4ce7a4fdd68a7357c5de35d7e 100755 --- a/docs/Quectel-Pi-H1/en/sidebar.yaml +++ b/docs/Quectel-Pi-H1/en/sidebar.yaml @@ -161,6 +161,8 @@ items: file: Applications/wx_development.md - label: ROS 2 Humble installation guide file: Applications/ros_installation.md + - label: OpenClaw Deployment + file: Applications/openclaw/openclaw.md #- label: OpenCV # file: Applications/opencv.md #- label: RTSP Streaming diff --git a/docs/Quectel-Pi-H1/zh/Applications/README.md b/docs/Quectel-Pi-H1/zh/Applications/README.md index 5a7bc08912f2527bdf17fa82ad425b5fd40d82de..60d8dcfdfdcba1d97228c6710ad22a315d6dd922 100644 --- a/docs/Quectel-Pi-H1/zh/Applications/README.md +++ b/docs/Quectel-Pi-H1/zh/Applications/README.md @@ -11,5 +11,6 @@ - [Qt图形界面开发](./qt_development.md) - [wx图形界面开发](./wx_development.md) - [安装ROS系统](./ros_installation.md) +- [OpenClaw部署](./openclaw.md) - [容器部署和使用指南](./container_deployment.md) - [开源项目](./Open-Source-Projects/README.md) diff --git a/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw17.png b/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw17.png new file mode 100644 index 0000000000000000000000000000000000000000..6bd5a0c249fda027eac5723ce19482d48be6e6ef Binary files /dev/null and b/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw17.png differ diff --git a/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw18.png b/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw18.png new file mode 100644 index 0000000000000000000000000000000000000000..ba2f812468f1f51da37fa9d89947a1a1ee7fb7fd Binary files /dev/null and b/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw18.png differ diff --git a/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw19.png b/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw19.png new file mode 100644 index 0000000000000000000000000000000000000000..9e7b30be267bc1a45d6248617227fdf83daa33c8 Binary files /dev/null and b/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw19.png differ diff --git a/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw20.png b/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw20.png new file mode 100644 index 0000000000000000000000000000000000000000..d124c266d9841dbf942e096d74afd34b54ba3a27 Binary files /dev/null and b/docs/Quectel-Pi-H1/zh/Applications/media/OpenClaw20.png differ diff --git a/docs/Quectel-Pi-H1/zh/Applications/openclaw.md b/docs/Quectel-Pi-H1/zh/Applications/openclaw.md index f53753d96c5579195b3f3e8f3614c640604a4604..990d881d39578ce3ea10708c690a14d1cc9cb1d2 100644 --- a/docs/Quectel-Pi-H1/zh/Applications/openclaw.md +++ b/docs/Quectel-Pi-H1/zh/Applications/openclaw.md @@ -183,6 +183,12 @@ openclaw pairing approve feishu "提示中的Pairing code" ## OpenClaw功能演示 +在终端中执行 `openclaw dashboard` 命令，即可查看 OpenClaw 对应的 Web 管理页面访问地址。 + + + + + ### 开源项目部署 1.完成 OpenClaw 部署后，可让其参考官网开源项目部署[指导文档](./Open-Source-Projects/README.md)，完成对应 Demo 环境的部署配置； @@ -193,6 +199,10 @@ openclaw pairing approve feishu "提示中的Pairing code" +效果截图： + + + ### 控制外设 通过 OpenClaw 的 Web 控制页面发送对话指令，等待片刻后，即可在外接显示屏上看到 USB 摄像头的实时预览画面。 @@ -200,3 +210,5 @@ openclaw pairing approve feishu "提示中的Pairing code" + + diff --git a/docs/Quectel-Pi-H1/zh/User-Guide/Remote-Access/vnc.md b/docs/Quectel-Pi-H1/zh/User-Guide/Remote-Access/vnc.md index 95fcb8136384f2bc4e8aa1140dc21cfdaa45706d..49984a49407f9a78cf015db76712f2cf2300cbd5 100644 --- a/docs/Quectel-Pi-H1/zh/User-Guide/Remote-Access/vnc.md +++ b/docs/Quectel-Pi-H1/zh/User-Guide/Remote-Access/vnc.md @@ -15,6 +15,7 @@ ```bash sudo apt update sudo apt install -y xvfb xfce4 x11vnc +sudo apt install --reinstall libdbus-1-3 dbus dbus-x11 ``` - 若安装过程中出现选项提示，直接按`回车键`即可。