From 89a1f20322ea984e4f82cb31c64b09abbe864be2 Mon Sep 17 00:00:00 2001 From: Yue Yin Date: Wed, 23 Jul 2025 13:01:34 +0900 Subject: [PATCH] Update README.md (#6) - Revised intro paragraph - Update deprecated code snippet --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index db1b0e2..4233ebb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # OpenArm CAN Library A C++ library for CAN communication with OpenArm robotic hardware, supporting Damiao motors over CAN/CAN-FD interfaces. -This library is a part of [OpenArm SDK](https://github.com/enactic/openarm_sdk). +This library is a part of [OpenArm](https://github.com/enactic/openarm/). See detailed setup guide and docs [here](https://docs.openarm.dev/software/can) + ## Quick Start @@ -39,10 +40,16 @@ sudo cmake --install build ```cpp #include +#include openarm::can::socket::OpenArm arm("can0", true); // CAN-FD enabled -arm.init_arm_motors({MotorType::DM4310}, {0x01}, {0x11}); -arm.enable_all(); +std::vector motor_types = { + openarm::damiao_motor::MotorType::DM4310, openarm::damiao_motor::MotorType::DM4310}; +std::vector send_can_ids = {0x01, 0x02}; +std::vector recv_can_ids = {0x11, 0x12}; + +openarm.init_arm_motors(motor_types, send_can_ids, recv_can_ids); +openarm.enable_all(); ``` ### 3. Python (🚧 EXPERIMENTAL - TEMPORARY 🚧)