From ed25b31b70a7d0c15fd042e92c1ee1125aa58b5b Mon Sep 17 00:00:00 2001 From: Alvin-lyq <2601685812@qq.com> Date: Tue, 23 Sep 2025 14:16:33 +0800 Subject: [PATCH] update README --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 47 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9cbdda7..c52ba1e 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,9 @@ * **ROS2 版本**:Humble * **Ubuntu 版本**:2204 -### 2.2 .deb的安装、启动与卸载 +### 2.2 .deb 的安装、启动与卸载 -在目标机器上执行: +在目标机器上执行安装: ```bash sudo dpkg -i controller_XXXX_arm64.deb @@ -25,51 +25,83 @@ sudo dpkg -i controller_XXXX_arm64.deb sudo apt-get -f install ``` -安装完成后,文件会放到: +安装完成后主要文件路径: 工作空间:/opt/controller/ 启动脚本:/opt/controller/start_all.sh -systemd 服务:/etc/systemd/system/controller.service +CAN 配置脚本:/opt/controller/can.sh -驱动会开机自启, 如果要手动启动/重启: +日志文件:/var/log/controller/controller.log +systemd 服务: + +CAN 配置服务:/etc/systemd/system/controller-can.service + +ROS2 节点服务:/etc/systemd/system/controller.service + +安装后,CAN 配置服务会先运行,确保 can0 接口可用,然后 ROS2 节点服务会启动。 + + +手动启动 ROS2 节点: ```bash sudo systemctl start controller.service +``` + +重启服务: +```bash sudo systemctl restart controller.service ``` -查看运行状态(是否正常启动节点): - +启动 CAN 配置服务(通常自动执行,不需要手动): ```bash -sudo systemctl status controller.service +sudo systemctl start controller-can.service ``` -查看日志 : systemd 管理的服务日志可以通过 journalctl 查看: +查看运行状态 +```bash +sudo systemctl status controller.service +sudo systemctl status controller-can.service +``` +实时查看最新日志: +```bash +tail -f /var/log/controller/controller.log +``` + +也可以使用 journalctl 查看 systemd 输出: ```bash sudo journalctl -u controller.service -f ``` -停止 +旧日志会自动轮转,由 logrotate 管理,每天生成一个历史日志,历史日志会压缩 .gz,默认保留最近 14 天日志 +轮转后的文件示例: +```bash +/var/log/controller/controller.log # 当天日志 +/var/log/controller/controller.log-20250923.gz # 历史压缩日志 +``` + +停止服务 ```bash sudo systemctl stop controller.service +sudo systemctl stop controller-can.service ``` -禁用开机启动: - +禁用开机自启 ```bash sudo systemctl disable controller.service +sudo systemctl disable controller-can.service ``` -卸载 deb 包: - +卸载 deb 包 ```bash sudo dpkg -r controller ``` +卸载包后 日志文件会保留,便于调试。 + ## 3. 消息(msg)文件详情 ### 3.1 McCtrl.msg(车辆控制指令消息) @@ -129,4 +161,5 @@ sudo dpkg -r controller | ---- | -------- | ------------------------------------------------------------ | ------------------ | | V1.0 | 2025-09-17 | 初始版本,定义`McCtrl.msg`和`Rtk.msg`结构,明确 Topic | \[zxwl] | | V1.1 | 2025-09-22 | controller.deb的安装、启动与卸载 | \[zxwl] | +| V1.2 | 2025-09-23 | 增加日志管理 | \[zxwl] |