first commit

Author: RosenYin

.gitignore

@@ -0,0 +1,7 @@
+.VSCodeCounter
+.vscode
+*.log
+__pycache__
+*.7z
+*.zip
+*.tar

DEVELOPMENT.MD

@@ -0,0 +1,91 @@
+# PIPER SDK 开发文档
+
+本SDK用于接收can数据帧，然后处理为自定义数据类型
+
+## 程序结构
+
+```shell
+piper_sdk
+├── piper_msgs
+├── base
+├── config
+├── demo
+├── hardware_port
+├── __init__.py
+├── interface
+├── protocol
+└── README.MD
+```
+
+底层交互：
+
+```shell
+hardware_port
+├── can_encapsulation.py
+└── __init__.py
+```
+
+机械臂数据变量：
+
+预留v2版本，为日后修改数据格式留出余量
+
+```shell
+piper_msgs
+├── msg_v1
+│   ├── arm_id_type_map.py
+│   ├── arm_messages.py
+│   ├── arm_msg_type.py
+│   ├── can_id.py
+│   ├── feedback
+│   │   ├── arm_crash_protection_rating_feedback.py
+│   │   ├── arm_end_pose.py
+│   │   ├── arm_feedback_current_end_vel_acc_param.py
+│   │   ├── arm_feedback_current_motor_angle_limit_max_spd.py
+│   │   ├── arm_feedback_current_motor_max_acc_limit.py
+│   │   ├── arm_feedback_joint_vel_acc.py
+│   │   ├── arm_high_spd_feedback.py
+│   │   ├── arm_joint_feedback.py
+│   │   ├── arm_low_spd_feedback.py
+│   │   ├── arm_status.py
+│   │   └── gripper_feedback.py
+│   ├── __init__.py
+│   └── transmit
+│       ├── arm_circular_pattern.py
+│       ├── arm_crash_protection_rating_config.py
+│       ├── arm_end_vel_acc_param_config.py
+│       ├── arm_gripper_ctrl.py
+│       ├── arm_joint_config.py
+│       ├── arm_joint_ctrl.py
+│       ├── arm_light_ctrl.py
+│       ├── arm_master_slave_config.py
+│       ├── arm_motion_ctrl_1.py
+│       ├── arm_motion_ctrl_2.py
+│       ├── arm_motion_ctrl_cartesian.py
+│       ├── arm_motor_angle_limit_max_spd_config.py
+│       ├── arm_motor_enable_disable.py
+│       ├── arm_param_enquiry_and_config.py
+│       ├── arm_search_motor_max_angle_spd_acc_limit.py
+│       └── arm_set_instruction_response.py
+└── msg_v2
+```
+
+机械臂协议解析：
+
+暂为v1版本，为日后修改协议留出余量
+
+```shell
+protocol
+├── piper_protocol_base.py
+└── protocol_v1
+    ├── piper_protocol_v1.py
+    └── __init__.py
+```
+
+机械臂实际接口：
+
+具体使用部分接口，抽象为具体功能函数，部分功能可能需要二次封装
+
+```shell
+interface
+└── piper_interface.py
+```

README.MD

@@ -0,0 +1,76 @@
+# Piper 机械臂 SDK使用说明
+
+## 安装方法
+
+### 安装依赖
+
+```shell
+pip3 install python-can
+```
+
+## 快速使用
+
+### 使能can模块
+
+**can模块设定脚本`can_config.sh`**
+
+首先需要设置好shell脚本参数
+
+#### 单条机械臂
+
+在`can_config.sh`中，`EXPECTED_CAN_COUNT`参数设置为`1`，因为一条机械臂使用一个can模块
+
+##### pc只插入一个usb转can模块
+
+直接执行
+
+```bash
+bash can_config.sh can0 1000000
+```
+
+##### pc插入多个usb转can模块
+
+拔掉所有can模块
+
+只将连接到机械臂的can模块插入PC，执行`sudo ethtool -i can0 | grep bus`，并记录下`bus-info`的数值例如`1-2:1.0`
+
+ps:**一般第一个插入的can模块会默认是can0，如果没有查询到can可以使用`ip link show`来显示所有can，然后先后插入查看can编号**
+
+假设上面的操作记录的`bus-info`数值为`1-2:1.0`
+
+然后执行,查看can设备是否激活成功
+
+```bash
+bash can_config.sh can_piper 1000000 "1-2:1.0"
+```
+
+ps:**此处的意思是，1-2:1.0硬件编码的usb端口插入的can设备，名字被重命名为can_piper，波特率为1000000，并激活**
+
+然后执行`ifconfig`查看是否有`can_piper`，如果有则can模块设置成功
+
+#### 两对机械臂(四条)
+
+如果是四条机械臂，也就是两对主从机械臂
+
+在`can_config.sh`中，`EXPECTED_CAN_COUNT`参数一般设置为`2`，因为四条机械臂使用两个can模块
+
+然后将两个can模块中的其中一个(一般第一个插入左臂所在的模块)单独插入PC，执行`sudo ethtool -i can0 | grep bus`，并记录下`bus-info`的数值例如`1-2:1.0`
+
+接着插入下一个can模块，注意不可以与上次can模块插入的usb口相同，然后执行`sudo ethtool -i can1 | grep bus`
+
+ps:**一般第一个插入的can模块会默认是can0，第二个为can1，如果没有查询到can可以使用`ip link show`来显示所有can，然后先后插入查看can编号**
+
+假设上面的操作记录的`bus-info`数值分别为`1-2:1.0`、`1-4:1.0`
+
+则将下面的`USB_PORTS["1-9:1.0"]="can_left:1000000"`中的中括号内部的双引号内部的参数换为`1-2:1.0`，另一个同理
+`USB_PORTS["1-5:1.0"]="can_right:1000000"` -> `USB_PORTS["1-4:1.0"]="can_right:1000000"`
+
+ps:**此处的意思是，1-2:1.0硬件编码的usb端口插入的can设备，名字被重命名为can_left，波特率为1000000，并激活**
+
+然后执行`bash can_config.sh`,查看两个can设备是不是激活成功
+
+然后执行`ifconfig`查看是不是有`can_left`和`can_right`，如果有则can模块设置成功
+
+## 注意事项
+
+- 需要先激活can设备，并且设置正确的波特率，才可以读取机械臂消息或者控制机械臂

__init__.py

@@ -0,0 +1,22 @@
+
+from .piper_msgs.msg_v1 import *
+from .protocol.protocol_v1 import *
+from .hardware_port.can_encapsulation import C_STD_CAN
+from .base.piper_base import C_PiperBase
+from .interface.piper_interface import C_PiperInterface
+
+__all__ = [
+    'C_PiperParserBase',
+    'C_PiperParserV1',
+    'ArmMsgEndPoseFeedBack',
+    'PiperMessage',
+    'CanIDPiper',
+    'ArmMsgJointFeedBack',
+    'ArmMsgType',
+    'ArmMsgStatus',
+    'ArmMsgGripperFeedBack',
+    'C_STD_CAN',
+    'C_PiperBase',
+    'C_PiperInterface'
+]
+

base/__init__.py

@@ -0,0 +1,7 @@
+
+from .piper_base import C_PiperBase
+
+__all__ = [
+    'C_PiperBase'
+]
+

base/piper_base.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python3
+# -*-coding:utf8-*-
+
+#机械臂控制base
+
+import can
+from can.message import Message
+from typing import (
+    Optional,
+)
+from typing import Type
+
+from ..interface.piper_interface import C_PiperInterface
+from ..hardware_port.can_encapsulation import C_STD_CAN
+
+class C_PiperBase(C_PiperInterface):
+    def __init__(self, can_name: str = "can0") -> None:
+        super().__init__(can_name)
+    
+    def Connect(self, can_name:str):
+        return self.ConnectPort(can_name)