# arm-server

**Repository Path**: whl1729/arm-server

## Basic Information

- **Project Name**: arm-server
- **Description**: 机械臂服务端
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-08
- **Last Updated**: 2024-12-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ARM Server

机械臂服务端

## 安装

```sh
./script/install_dependencies.sh
```

## 运行

```sh
python main.py
```

## HTTP API

### 发送命令给机械臂客户端

- 方法: POST
- 路径: `/arm`
- 请求参数

  | 字段 | 类型 | 描述 |
  | -- | -- | -- |
  | command | string | 发送给机械臂客户端的命令 |

- 请求参数示例

```json
{
  "command": "不如跳舞"
}
```

- 返回结果

  | 字段 | 类型 | 描述 |
  | -- | -- | -- |
  | code | int | 0 代表发送成功，非 0 代表发送失败 |
  | id | string | 命令 ID，查询命令结果时需要用到 |
  | message | string | 调试信息 |

- 返回结果示例

```json
{
  "code": 0,
  "id": "1733628974.7991564",
  "message": "命令发送成功"
}
```

### 查询机械臂客户端命令执行结果

- 方法：GET
- 路径：`/arm`
- 请求参数示例

```json
{
  "id": "1733628974.7991564"
}
```

- 返回结果

  | 字段 | 类型 | 描述 |
  | -- | -- | -- |
  | code | int | 0 代表发送成功，非 0 代表发送失败 |
  | id | string | 命令 ID |
  | message | string | 调试信息 |

- 返回结果示例

```json
{
  "code": 0,
  "id": "1733628974.7991564",
  "message": "跳完舞啦"
}
```