openarm/openarm_can
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md (#6)

Browse Source 
- Revised intro paragraph
- Update deprecated code snippet
This commit is contained in:
Yue Yin 2025-07-23 13:01:34 +09:00 committed by GitHub
parent 5d502ab732
commit 89a1f20322
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,7 +1,8 @@
# OpenArm CAN Library # OpenArm CAN Library
A C++ library for CAN communication with OpenArm robotic hardware, supporting Damiao motors over CAN/CAN-FD interfaces. 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 ## Quick Start
@ -39,10 +40,16 @@ sudo cmake --install build
```cpp ```cpp
#include <openarm/can/socket/openarm.hpp> #include <openarm/can/socket/openarm.hpp>
#include <openarm/damiao_motor/dm_motor_constants.hpp>
openarm::can::socket::OpenArm arm("can0", true); // CAN-FD enabled openarm::can::socket::OpenArm arm("can0", true); // CAN-FD enabled
arm.init_arm_motors({MotorType::DM4310}, {0x01}, {0x11}); std::vector<openarm::damiao_motor::MotorType> motor_types = {
arm.enable_all(); openarm::damiao_motor::MotorType::DM4310, openarm::damiao_motor::MotorType::DM4310};
std::vector<uint32_t> send_can_ids = {0x01, 0x02};
std::vector<uint32_t> recv_can_ids = {0x11, 0x12};
openarm.init_arm_motors(motor_types, send_can_ids, recv_can_ids);
openarm.enable_all();
``` ```
### 3. Python (🚧 EXPERIMENTAL - TEMPORARY 🚧) ### 3. Python (🚧 EXPERIMENTAL - TEMPORARY 🚧)