移动 (Move) API

interface MoveActionCreate {
  creator: string; // 动作的发起者（仅用于诊断目的）。
  type:
    | 'standard'
    | 'charge' // 前往充电桩并对接。
    | 'return_to_elevator_waiting_point'
    | 'enter_elevator'
    | 'leave_elevator' // 已废弃。请勿使用。
    | 'along_given_route' // 已废弃。请改用其他移动类型并配合 `route_coordinates`。
    | 'align_with_rack' // 钻入货架下方（以便后续顶升）。
    | 'to_unload_point' // 移动到货架卸货点（以便后续落下）。
    | 'follow_target' // 跟随移动目标。
    | 'load_onto_truck' // 将机器人载着的货架装到货车上。
    | 'unload_from_truck'; // 从货车上卸下货架。
  target_x?: number;
  target_y?: number;
  target_z?: number;
  target_ori?: number;
  target_accuracy?: number; // 单位：米（可选）。

  // 要遵循的路径。
  //
  // 大多数移动类型均支持，例如 `standard`、`charge`、`align_with_rack`。
  // 以逗号分隔的坐标列表字符串，
  // 格式为 "x1, y1, x2, y2"。
  route_coordinates?: string;

  // 沿着指定路径移动时，绕过障碍物的允许偏航距离。
  //
  // 大多数移动类型均支持，例如 `standard`、`charge`、`align_with_rack`。
  // 当指定为 0 时，机器人遇到障碍物会始终停止并等待，而不会尝试绕行。
  detour_tolerance?: number;

  // 如果为 true，当机器人进入 `target_accuracy` 半径范围内时，动作将立即成功。
  use_target_zone?: boolean = false;

  charge_retry_count?: number; // `charge` 动作失败前的重试次数。

  rack_area_id: string; // 执行点到区域或区域到区域的货物移动动作时，提供目标货架区域 ID。

  properties?: { // 可选：自 2.11.0 起支持
    inplace_rotate?: boolean; // 可选。自 2.11.0 起支持：严格原地旋转，不带任何线速度。

    // 可选。货架堆叠层数的索引。
    // 用于 type = "align_with_rack" 和 "to_unload_point"。
    rack_layer?: number;

    // 要操作的货车点位，格式为 "<货车 SN>/<点名>"，
    // 例如 "PS55606h08893jr/GL"。
    // 用于 type = "load_onto_truck" 和 "unload_from_truck"，这两个类型不驶向目标位姿。
    target_id?: string;
  }
}

interface MoveAction extends MoveActionCreate {
  state: "idle" | "moving" | "succeeded" | "failed" | "cancelled";
  create_time: number; // Unix 时间戳 (例如：1647509573)。
  last_modified_time: number; // Unix 时间戳 (例如：1647509573)。
  fail_reason: number; // 失败代码。仅当 state="failed" 时有效。
  // 用于调试的内部失败消息。仅当 state="failed" 时有效。
  fail_reason_str: string;
  // 用于调试的中文内部失败消息。仅当 state="failed" 时有效。
  fail_message: string;
}

enum MoveFailReason {
  none = 0, // 无
  unknown = 1, // 未知原因
  GetMapFailed = 2, // 获取地图失败 (WorldMap)
  StartingPointOutOfMap = 3, // 起点在地图外
  EndingPointOutOfMap = 4, // 终点在地图外
  StartingPointNotInGround = 5, // 起点不在可行驶区域
  EndingPointNotInGround = 6, // 终点不在可行驶区域
  StartingEqualEnding = 7, // 起点和终点相同
  CalculateGlobalPathExtendedDataError = 8, // 计算全局路径扩展数据失败
  CalculationFailed = 9, // 道路不通
  CalculationTimeout = 10, // 计算超时
  NoGlobalPath = 11, // 无可用全局路径
  NotGrabStartIndexOnGlobalPath = 12, // 未能在全局路径上抓取起点
  NotGrabEndIndexOnGlobalPath = 13, // 未能在全局路径上抓取终点
  PlanningTimeout = 14, // 路径规划长时间不成功
  MoveTimeout = 15, // 路径规划成功，移动超时
  ControlCostmapError = 16, // 局部避障地图数据错误，传感器数据异常
  PowerCableConnected = 17, // 当前正连接线缆充电
  RotateTimeout = 18, // 旋转超时
  ChargeRetryCountExceeded = 100, // 充电重试次数超限
  ChargeDockDetectionError = 101, // 充电桩检测错误
  ChargeDockSignalError = 102, // 未收到充电桩对接成功信号
  InvalidChargeDock = 103, // 充电桩位置无效
  AlreadyInCharging = 104, // 当前已在充电中
  NoChargeCurrent = 105, // 接触后长时间未收到充电电流
  InvalidCabinetPos = 200, // 柜体位置无效
  CabinetDetectionError = 201, // 柜体检测错误
  NoDockWithConveyer = 202, // 当前未与接驳线对接
  NoApproachConveyer = 203, // 当前未靠近接驳线
  ElevatorPointOccupied = 300, // 电梯点被占用
  ElevatorClosed = 301, // 电梯已关闭
  ElevatorPointObscuredTimeout = 302, // 电梯点长时间被遮挡
  ElevatorPointOccupancyDetectionTimeout = 303, // 电梯点占用检测超时
  ElevatorEnterProgressUpdateTimeout = 304, // 进电梯进度更新超时
  InvalidTrackPoints = 400, // 轨迹点无效（输入坐标数不是偶数或轨迹点数 < 2）
  TooFarFromStartOfTrack = 401, // 距离轨迹起点太远
  InvalidRackDetectionPos = 500, // 货架检测点无效
  RackDetectionError = 501, // 货架检测错误
  RackRetryCountExceeded = 502, // 对接重试次数超限
  UnloadPointOccupied = 503, // 卸货点被占用
  UnloadPointUnreachable = 504, // 卸货点不可达
  RackMoved = 505, // 货架发生了明显移动
  JackInUpState = 506, // 顶升处于升起状态
  InvalidRackAreaId = 507, // 货架区域 ID 无效
  InvalidRackArea = 508, // 货架区域无效（无货架位）
  UnknownRackSpaceState = 509, // 货架空间状态未知
  NoRackInRackArea = 510, // 货架区域内无货架
  AlignFailedInRackArea = 511, // 在有货架的区域内对接失败
  NoFreeSpaceInRackArea = 512, // 货架区域内无空闲空间
  FailedToUnloadInRackArea = 513, // 在有空闲货架位的区域内卸货失败
  FollowFailed = 600, // 跟随目标丢失
  PoiDetectionError = 700, // POI 检测错误
  PoiUnreachable = 701, // POI 不可达
  BarcodeDetectionError = 702, // 条码检测错误
  NotAtTruckGroundPoint = 800, // 不在货车候车点
  LiftgateWaitTimeout = 801, // 等待货车尾板超时
  JackOperationFailed = 802, // 顶升升降失败或超时
  LoadInJackDownState = 803, // 卡车装货时顶升处于降下状态
  UnloadInJackUpState = 804, // 卡车卸货时顶升处于升起状态
  PlatformAlertError = 1000, // 系统异常
  ServiceCallError = 1001, // 服务调用错误 (restapi 使用层)
  InternalError = 1002, // 内部 ASSERT 错误
  MapChanged = 1003, // 任务执行期间地图发生变化或被清除
  MoveActionTypeDeprecated = 1004, // 接口已废弃
}