快速开始

本节将帮助您快速掌握 Python API 的基本结构及其使用方法。

1. 搭建开发环境

在开始开发前，请先确保已满足以下 Python 开发环境：

操作系统：Ubuntu22 及以上。
Python：3.10。

2. 安装 alphabot 模块

搭建完 Python 开发环境后，即可通过 pip 工具安装 alphabot 模块。

在终端中，进入软件包解压后的 python 目录。
Terminal window
```
cd python
```
通过 pip 安装 alphabot 模块。
Terminal window
```
pip install .
```

3. 了解模块结构

您可以浏览 alphabot 目录下的 .pyi 接口文件，了解接口模块划分。

alphabot 模块提供了多个可直接使用的类，支持通过 from alphabot import 类名 的方式导入。

类名	说明	模块
ArmFactory	创建机械臂	机械臂 alphabot.arm
ArmFactoryParam	描述机械臂相关参数
ArmInterface	机械臂控制的主接口
ArmForceSensor	力传感器数据
ArmRealtimeState	机械臂实时状态
GripperState	夹爪状态
JointState	关节状态
PeripheralReadWriteParams	Modbus 通信参数配置类
ChassisFactory	创建底盘	底盘 alphabot.chassis
ChassisInterface	底盘控制的主接口
ChassisBattery	底盘电池相关信息
ChassisPoint32	轮廓点位置
ChassisPose2D	底盘 2D 位姿
ChassisPoseSpeed	底盘位姿和速度
ChassisState	底盘状态
ChassisStatusCode	底盘状态码
ChassisTransformStamped	静态变换相关的数据
ChassisTwist	底盘速度
ChassisOperationState	底盘操作状态
NavState	底盘导航信息
RobotBit	底盘位信息
HeadFactory	创建头部	头部 alphabot.head
HeadInterface	头部控制的主接口
AbcHeadState	头部关节状态
TorsoFactoryPose4D	创建躯干	躯干 alphabot.torso
TorsoInterfacePose4D	躯干控制的主接口
AbcTorsoState	躯干关节状态
SensorFactory	创建传感器和深度相机	传感器 alphabot.sensor
SyncDataPackage	同步传感器数据包
SyncMode	同步模式
SyncPolicy	同步策略
RGBData	彩色图像数据
RGBDData	彩色+深度图像数据
DepthCamera	深度相机传感器
DepthSensorParam	深度传感器参数
EStopMonitor	急停按钮监控器	急停按钮监控器 alphabot.estop
EStopMConfig	监控配置
ESState	急停按钮状态
ArmKinematics	机械臂运动学	运动学 alphabot.algo
ArmType	机械臂型号
TorsoKinematics	躯干运动学
admittance_control_law	导纳控制律
AbcErrorCode	错误码	共用数据结构 alphabot.core
AbcTorsoPose4D	躯干位姿
ArmCurrentStatus	机械臂当前状态码
Euler	欧拉角
Pose	3D 空间位姿
Position	3D 坐标
Quaternion	四元数
SensorStatus	传感器状态
SensorType	传感器类型

4. 参考示例程序

参考 examples 下的示例程序，掌握核心接口调用。

例如，Python\examples\arm\arm_factory_example.py 样例程序代码如下所示。

import sys
import os
from alphabot import ArmFactory, ArmFactoryParam


def main():
    """Main function"""
    # Parameter validation
    if len(sys.argv) < 2:
        print(f"Usage: {sys.argv[0]} <configuration_file_path>")
        print(f"Example: {sys.argv[0]} config/left_arm.json")
        return 1

    config_path = sys.argv[1]

    print("===== ArmFactory Sample Program =====")

    try:
        print("\n----- Method 1: Creating a Robotic Arm Using Parameters -----")
        # Configure robotic arm parameters
        param = ArmFactoryParam({
            "arm_type": "realman",
            "arm_name": "right_arm",
            "ip": "192.168.1.18",
            "port": "8080",
            "udp_ip": "192.168.1.102",
            "udp_port": "8089",
            "udp_cycle": "5"
        })

        # Create robotic arm instance
        arm1 = ArmFactory.create_arm(param)
        if not arm1:
            print("Failed to create robotic arm instance")
            return 1

        print(f"Successfully created robotic arm: {arm1}")

        print("\n----- Method 2: Creating a Robotic Arm Using Configuration File -----")
        # Create robotic arm instance from configuration file
        arm2 = ArmFactory.create_arm_from_config(config_path)
        if not arm2:
            print("Failed to create robotic arm instance from configuration file")
            return 1

        print(f"Successfully created robotic arm from configuration file: {arm2}")

        return 0

    except Exception as e:
        print(f"Exception occurred: {e}")
        return 1


if __name__ == "__main__":
    sys.exit(main())

通过上述示例程序，您可以快速了解如何创建机械臂接口实例，并连接机械臂。其他示例程序也具有类似的结构和调用方式，请参考更多的示例程序进行学习。

5. 运行

接下来以 Python\examples\arm\arm_factory_example.py 文件为例，讲解运行过程。

在终端中，进入示例程序所在目录。
Terminal window
```
cd python/examples/arm
```
执行 python 命令，便可运行程序。本示例需要传入机械臂配置文件路径参数。
Terminal window
```
python arm_factory_example.py ../config/left_arm.json
```

其他示例程序的运行方式与此类似，请参考上述步骤进行操作。

通过本节学习，您已经初步掌握了 Python 接口的结构和使用方法。建议您继续深入学习其他示例程序，并结合接口文档进行开发实践，以更好地理解和应用 Python 接口。