Compare commits

..

57 Commits

Author SHA1 Message Date
yexiaozhou
c61dfb60e8 (layout optimizer) update README.md 2026-04-13 10:25:51 +08:00
yexiaozhou
cf0cbb990d Merge branch 'dev' into feat/3d_layout_and_visualize 2026-04-10 16:16:22 +08:00
yexiaozhou
99dc821a01 refactor(layout_optimizer): DE optimizer — discrete angles, strategy fixes, decoupled mutation, API exposure
- Extract _compute_mutant helper with circular angle diff (fixes 0/2π boundary bug)
- Fix currenttobest1bin (remove non-standard noise term), add rand1bin strategy
- Decoupled mutation: independent F ranges for position vs theta
- Configurable crossover mode: per-device (default) or per-dimension
- Discrete angle snapping in normal 3N DE (joint mode, replaces hybrid as default)
- Stop auto-injecting prefer_orientation_mode into DE
- Expose DE hyperparameters (mutation, theta_mutation, recombination, strategy, angle_mode) via API
2026-04-10 14:41:13 +08:00
Xuwznln
58997f0654 fix create_resource_with_slot 2026-04-09 17:34:25 +08:00
Xuwznln
fbfc3e30fb update unilabos_formulation & batch-submit-exp 2026-04-09 16:40:31 +08:00
Xuwznln
1d1c1367df scale multi exec thread up to 48 2026-04-09 14:15:38 +08:00
yexiaozhou
a7a6d77d7a fix(layout_optimizer): apply code review follow-ups 2026-04-03 01:42:22 +08:00
yexiaozhou
00bdf9b822 feat(layout_optimizer): add angle-first hybrid discrete-theta mode 2026-04-03 01:09:00 +08:00
yexiaozhou
306b787aa7 fix(layout_optimizer): update arm_slider reach value and improve scene poll version handling 2026-04-03 00:43:40 +08:00
Xuwznln
c91b600e90 update handle creation api 2026-04-02 22:53:31 +08:00
yexiaozhou
5b3f317867 Merge branch 'rescue-layout-opt-detached' into feat/3d_layout_and_visualize 2026-04-02 16:32:27 +08:00
Xuwznln
49b3c850f9 fit cocurrent gap 2026-04-02 16:01:23 +08:00
yexiaozhou
b0e98ccf2b docs(layout_optimizer): deprecate align_weight in demo_agent.md
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-02 13:52:18 +08:00
yexiaozhou
b04dc8dd4a feat(layout_optimizer): default cardinal snap and alignment to off
align_weight defaults to 0 (was DEFAULT_WEIGHT_ANGLE=60).
snap_theta_safe is opt-in via snap_cardinal=True (was always-on).
Both remain available when explicitly requested.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-02 13:48:34 +08:00
yexiaozhou
f4c0e40a25 feat(layout_optimizer): crossing penalty weighted by intersection length
Replace _line_of_sight_penalty (flat per-blocker) with _crossing_penalty
(DEFAULT_WEIGHT_DISTANCE * crossing_length). Uses opening→arm-OBB
endpoints. Applied regardless of reachability pass/fail.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-02 13:33:38 +08:00
yexiaozhou
569ac4a931 feat(layout_optimizer): add segment_obb_intersection_length (Cyrus-Beck clipping)
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-02 13:24:45 +08:00
yexiaozhou
31e79e9aff chore(DE): add debug mode and detailed log regarding cost changes 2026-04-02 12:52:44 +08:00
yexiaozhou
6e1b26a754 fix(server): update path configuration for asset directories 2026-04-01 22:07:44 +08:00
Xuwznln
25c94af755 add running status debounce 2026-04-01 16:01:22 +08:00
yexiaozhou
9ef24b7768 feat(layout_optimizer): DE optimizer V2 — custom loop, graduated hard constraints, broad phase
Replace scipy differential_evolution with custom DE loop for per-device
crossover, circular θ wrapping, and configurable mutation strategy
(currenttobest1bin default, best1bin as turbo mode).

Key improvements:
- Graduate ALL hard constraints during DE (proportional penalty instead of
  flat inf), giving DE smooth gradient for reachability, min_spacing, etc.
  Binary inf preserved for final pass/fail reporting.
- 2-axis sweep-and-prune AABB broad phase for collision pair pruning
- Multi-seed injection from multiple seeder presets + Gaussian variants
- snap_theta_safe: collision-check after angle snapping, revert on violation
- Weight normalization (100 distance / 60 angle / 5× hard multiplier)
- Constraint priority field (critical/high/normal/low → weight multiplier)
  with LLM intent interpreter setting priority per constraint type
- Final success field now checks user hard constraints in binary mode
- arm_slider added to mock checker reach table (1.07m)

Tests: 202 passed, 24 new tests added (optimizer 7, constraints 6, broad_phase 11)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-01 00:32:34 +08:00
Xuwznln
861a012747 allow non @topic_config support 2026-03-31 13:15:06 +08:00
yexiaozhou
64eeed56a1 feat: add layout_optimizer package for automatic layout of devices
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-31 09:30:40 +08:00
yexiaozhou
3f75ca4ea3 feat: add generated asset_models registry 2026-03-31 09:30:40 +08:00
Xuwznln
ee63e95f50 update skill 2026-03-25 23:20:13 +08:00
Xuwznln
dbf5df6e4d add placeholder keys 2026-03-25 12:11:10 +08:00
Xuwznln
f10c0343ce add placeholder keys 2026-03-25 11:56:40 +08:00
Xuwznln
8b6553bdd9 always free 2026-03-25 11:24:19 +08:00
Xuwznln
e7a4afd6b5 提交实验技能 2026-03-25 00:42:28 +08:00
Xuwznln
f18f6d82fc disable samples 2026-03-24 23:45:50 +08:00
Xuwznln
b7c726635c correct sample demo ret value 2026-03-24 23:24:12 +08:00
Xuwznln
c809912fd3 新增试剂reagent 2026-03-24 23:22:45 +08:00
Xuwznln
d956b27e9f update registry 2026-03-24 23:10:57 +08:00
Xuwznln
ff1e21fcd8 新增manual_confirm 2026-03-24 23:04:00 +08:00
Xuwznln
b9d9666003 add workstation creation skill 2026-03-24 23:03:49 +08:00
Junhan Chang
d776550a4b add virtual_sample_demo 样品追踪测试设备 2026-03-23 16:43:20 +08:00
Xuwznln
3d8123849a add external devices param
fix registry upload missing type
2026-03-23 15:01:16 +08:00
Xuwznln
d2f204c5b0 bump to 0.10.19 2026-03-22 04:17:21 +08:00
Xuwznln
d8922884b1 fast registry load 2026-03-22 04:14:47 +08:00
Xuwznln
427afe83d4 minor fix on skill & registry 2026-03-22 03:36:28 +08:00
Xuwznln
23c2e3b2f7 stripe ros2 schema desc
add create-device-skill
2026-03-22 03:21:13 +08:00
Xuwznln
59c26265e9 new registry system backwards to yaml 2026-03-22 02:19:54 +08:00
Xuwznln
4c2adea55a remove not exist resource 2026-03-21 23:35:51 +08:00
Xuwznln
0f6264503a new registry sys
exp. support with add device
2026-03-21 19:26:24 +08:00
Junhan Chang
2c554182d3 add ai conventions 2026-03-19 14:14:40 +08:00
Xuwznln
6d319d91ff correct raise create resource error 2026-03-10 16:26:37 +08:00
Xuwznln
3155b2f97e ret info fix revert 2026-03-10 16:04:27 +08:00
Xuwznln
e5e30a1c7d ret info fix 2026-03-10 16:00:24 +08:00
Xuwznln
4e82f62327 fix prcxi check 2026-03-10 15:57:27 +08:00
Xuwznln
95d3456214 add create_resource schema 2026-03-10 15:27:39 +08:00
Xuwznln
38bf95b13c re signal host ready event 2026-03-10 14:13:06 +08:00
Xuwznln
f2c0bec02c add websocket connection timeout and improve reconnection logic
add open_timeout parameter to websocket connection
add TimeoutError and InvalidStatus exception handling
implement exponential backoff for reconnection attempts
simplify reconnection logic flow
2026-03-07 04:40:56 +08:00
Xuwznln
e0394bf414 Merge remote-tracking branch 'origin/dev' into dev 2026-03-04 19:18:55 +08:00
Xuwznln
975a56415a import gzip 2026-03-04 19:18:36 +08:00
Xuwznln
cadbe87e3f add gzip 2026-03-04 19:18:19 +08:00
Xuwznln
b993c1f590 add gzip 2026-03-04 19:18:09 +08:00
Xuwznln
e0fae94c10 change pose extra to any 2026-03-04 19:06:58 +08:00
Xuwznln
b5cd181ac1 add isFlapY 2026-03-04 18:59:45 +08:00
140 changed files with 60377 additions and 38704 deletions

View File

@@ -1,9 +0,0 @@
@echo off
setlocal enabledelayedexpansion
REM upgrade pip
"%PREFIX%\python.exe" -m pip install --upgrade pip
REM install extra deps
"%PREFIX%\python.exe" -m pip install paho-mqtt opentrons_shared_data
"%PREFIX%\python.exe" -m pip install git+https://github.com/Xuwznln/pylabrobot.git

View File

@@ -1,9 +0,0 @@
#!/usr/bin/env bash
set -euxo pipefail
# make sure pip is available
"$PREFIX/bin/python" -m pip install --upgrade pip
# install extra deps
"$PREFIX/bin/python" -m pip install paho-mqtt opentrons_shared_data
"$PREFIX/bin/python" -m pip install git+https://github.com/Xuwznln/pylabrobot.git

View File

@@ -0,0 +1,160 @@
---
name: add-device
description: Guide for adding new devices to Uni-Lab-OS (接入新设备). Uses @device decorator + AST auto-scanning instead of manual YAML. Walks through device category, communication protocol, driver creation with decorators, and graph file setup. Use when the user wants to add/integrate a new device, create a device driver, write a device class, or mentions 接入设备/添加设备/设备驱动/物模型.
---
# 添加新设备到 Uni-Lab-OS
**第一步:** 使用 Read 工具读取 `docs/ai_guides/add_device.md`,获取完整的设备接入指南。
该指南包含设备类别(物模型)列表、通信协议模板、常见错误检查清单等。搜索 `unilabos/devices/` 获取已有设备的实现参考。
---
## 装饰器参考
### @device — 设备类装饰器
```python
from unilabos.registry.decorators import device
# 单设备
@device(
id="my_device.vendor", # 注册表唯一标识(必填)
category=["temperature"], # 分类标签列表(必填)
description="设备描述", # 设备描述
display_name="显示名称", # UI 显示名称(默认用 id
icon="DeviceIcon.webp", # 图标文件名
version="1.0.0", # 版本号
device_type="python", # "python" 或 "ros2"
handles=[...], # 端口列表InputHandle / OutputHandle
model={...}, # 3D 模型配置
hardware_interface=HardwareInterface(...), # 硬件通信接口
)
# 多设备(同一个类注册多个设备 ID各自有不同的 handles 等配置)
@device(
ids=["pump.vendor.model_A", "pump.vendor.model_B"],
id_meta={
"pump.vendor.model_A": {"handles": [...], "description": "型号 A"},
"pump.vendor.model_B": {"handles": [...], "description": "型号 B"},
},
category=["pump_and_valve"],
)
```
### @action — 动作方法装饰器
```python
from unilabos.registry.decorators import action
@action # 无参:注册为 UniLabJsonCommand 动作
@action() # 同上
@action(description="执行操作") # 带描述
@action(
action_type=HeatChill, # 指定 ROS Action 消息类型
goal={"temperature": "temp"}, # Goal 字段映射
feedback={}, # Feedback 字段映射
result={}, # Result 字段映射
handles=[...], # 动作级别端口
goal_default={"temp": 25.0}, # Goal 默认值
placeholder_keys={...}, # 参数占位符
always_free=True, # 不受排队限制
auto_prefix=True, # 强制使用 auto- 前缀
parent=True, # 从父类 MRO 获取参数签名
)
```
**自动识别规则:**
-`@action` 的公开方法 → 注册为动作(方法名即动作名)
- **不带 `@action` 的公开方法** → 自动注册为 `auto-{方法名}` 动作
- `_` 开头的方法 → 不扫描
- `@not_action` 标记的方法 → 排除
### @topic_config — 状态属性配置
```python
from unilabos.registry.decorators import topic_config
@property
@topic_config(
period=5.0, # 发布周期(秒),默认 5.0
print_publish=False, # 是否打印发布日志
qos=10, # QoS 深度,默认 10
name="custom_name", # 自定义发布名称(默认用属性名)
)
def temperature(self) -> float:
return self.data.get("temperature", 0.0)
```
### 辅助装饰器
```python
from unilabos.registry.decorators import not_action, always_free
@not_action # 标记为非动作post_init、辅助方法等
@always_free # 标记为不受排队限制(查询类操作)
```
---
## 设备模板
```python
import logging
from typing import Any, Dict, Optional
from unilabos.ros.nodes.base_device_node import BaseROS2DeviceNode
from unilabos.registry.decorators import device, action, topic_config, not_action
@device(id="my_device", category=["my_category"], description="设备描述")
class MyDevice:
_ros_node: BaseROS2DeviceNode
def __init__(self, device_id: Optional[str] = None, config: Optional[Dict[str, Any]] = None, **kwargs):
self.device_id = device_id or "my_device"
self.config = config or {}
self.logger = logging.getLogger(f"MyDevice.{self.device_id}")
self.data: Dict[str, Any] = {"status": "Idle"}
@not_action
def post_init(self, ros_node: BaseROS2DeviceNode) -> None:
self._ros_node = ros_node
@action
async def initialize(self) -> bool:
self.data["status"] = "Ready"
return True
@action
async def cleanup(self) -> bool:
self.data["status"] = "Offline"
return True
@action(description="执行操作")
def my_action(self, param: float = 0.0, name: str = "") -> Dict[str, Any]:
"""带 @action 装饰器 → 注册为 'my_action' 动作"""
return {"success": True}
def get_info(self) -> Dict[str, Any]:
"""无 @action → 自动注册为 'auto-get_info' 动作"""
return {"device_id": self.device_id}
@property
@topic_config()
def status(self) -> str:
return self.data.get("status", "Idle")
@property
@topic_config(period=2.0)
def temperature(self) -> float:
return self.data.get("temperature", 0.0)
```
### 要点
- `_ros_node: BaseROS2DeviceNode` 类型标注放在类体顶部
- `__init__` 签名固定为 `(self, device_id=None, config=None, **kwargs)`
- `post_init``@not_action` 标记,参数类型标注为 `BaseROS2DeviceNode`
- 运行时状态存储在 `self.data` 字典中
- 设备文件放在 `unilabos/devices/<category>/` 目录下

View File

@@ -0,0 +1,351 @@
---
name: add-resource
description: Guide for adding new resources (materials, bottles, carriers, decks, warehouses) to Uni-Lab-OS (添加新物料/资源). Uses @resource decorator for AST auto-scanning. Covers Bottle, Carrier, Deck, WareHouse definitions. Use when the user wants to add resources, define materials, create a deck layout, add bottles/carriers/plates, or mentions 物料/资源/resource/bottle/carrier/deck/plate/warehouse.
---
# 添加新物料资源
Uni-Lab-OS 的资源体系基于 PyLabRobot通过扩展实现 Bottle、Carrier、WareHouse、Deck 等实验室物料管理。使用 `@resource` 装饰器注册AST 自动扫描生成注册表条目。
---
## 资源类型
| 类型 | 基类 | 用途 | 示例 |
|------|------|------|------|
| **Bottle** | `Well` (PyLabRobot) | 单个容器(瓶、小瓶、烧杯、反应器) | 试剂瓶、粉末瓶 |
| **BottleCarrier** | `ItemizedCarrier` | 多槽位载架(放多个 Bottle | 6 位试剂架、枪头盒 |
| **WareHouse** | `ItemizedCarrier` | 堆栈/仓库(放多个 Carrier | 4x4 堆栈 |
| **Deck** | `Deck` (PyLabRobot) | 工作站台面(放多个 WareHouse | 反应站 Deck |
**层级关系:** `Deck``WareHouse``BottleCarrier``Bottle`
WareHouse 本质上和 Site 是同一概念 — 都是定义一组固定的放置位slot只不过 WareHouse 多嵌套了一层 Deck。两者都需要开发者根据实际物理尺寸自行计算各 slot 的偏移坐标。
---
## @resource 装饰器
```python
from unilabos.registry.decorators import resource
@resource(
id="my_resource_id", # 注册表唯一标识(必填)
category=["bottles"], # 分类标签列表(必填)
description="资源描述",
icon="", # 图标
version="1.0.0",
handles=[...], # 端口列表InputHandle / OutputHandle
model={...}, # 3D 模型配置
class_type="pylabrobot", # "python" / "pylabrobot" / "unilabos"
)
```
---
## 创建规范
### 命名规则
1. **`name` 参数作为前缀**:所有工厂函数必须接受 `name: str` 参数,创建子物料时以 `name` 作为前缀,确保实例名在运行时全局唯一
2. **Bottle 命名约定**:试剂瓶-Bottle烧杯-Beaker烧瓶-Flask小瓶-Vial
3. **函数名 = `@resource(id=...)`**:工厂函数名与注册表 id 保持一致
### 子物料命名示例
```python
# Carrier 内部的 sites 用 name 前缀
for k, v in sites.items():
v.name = f"{name}_{v.name}" # "堆栈1左_A01", "堆栈1左_B02" ...
# Carrier 中放置 Bottle 时用 name 前缀
carrier[0] = My_Reagent_Bottle(f"{name}_flask_1") # "堆栈1左_flask_1"
carrier[i] = My_Solid_Vial(f"{name}_vial_{ordering[i]}") # "堆栈1左_vial_A1"
# create_homogeneous_resources 使用 name_prefix
sites=create_homogeneous_resources(
klass=ResourceHolder,
locations=[...],
name_prefix=name, # 自动生成 "{name}_0", "{name}_1" ...
)
# Deck setup 中用仓库名称作为 name 传入
self.warehouses = {
"堆栈1左": my_warehouse_4x4("堆栈1左"), # WareHouse.name = "堆栈1左"
"试剂堆栈": my_reagent_stack("试剂堆栈"), # WareHouse.name = "试剂堆栈"
}
```
### 其他规范
- **max_volume 单位为 μL**500mL = 500000
- **尺寸单位为 mm**`diameter`, `height`, `size_x/y/z`, `dx/dy/dz`
- **BottleCarrier 必须设置 `num_items_x/y/z`**:用于前端渲染布局
- **Deck 的 `__init__` 必须接受 `setup=False`**:图文件中 `config.setup=true` 触发 `setup()`
- **按项目分组文件**:同一工作站的资源放在 `unilabos/resources/<project>/`
- **`__init__` 必须接受 `serialize()` 输出的所有字段**`serialize()` 输出会作为 `config` 回传到 `__init__`,因此必须通过显式参数或 `**kwargs` 接受,否则反序列化会报错
- **持久化运行时状态用 `serialize_state()`**:通过 `_unilabos_state` 字典存储可变信息(如物料内容、液体量),只存 JSON 可序列化的基本类型
---
## 资源模板
### Bottle
```python
from unilabos.registry.decorators import resource
from unilabos.resources.itemized_carrier import Bottle
@resource(id="My_Reagent_Bottle", category=["bottles"], description="我的试剂瓶")
def My_Reagent_Bottle(
name: str,
diameter: float = 70.0,
height: float = 120.0,
max_volume: float = 500000.0,
barcode: str = None,
) -> Bottle:
return Bottle(
name=name,
diameter=diameter,
height=height,
max_volume=max_volume,
barcode=barcode,
model="My_Reagent_Bottle",
)
```
**Bottle 参数:**
- `name`: 实例名称(运行时唯一,由上层 Carrier 以前缀方式传入)
- `diameter`: 瓶体直径 (mm)
- `height`: 瓶体高度 (mm)
- `max_volume`: 最大容积(**μL**500mL = 500000
- `barcode`: 条形码(可选)
### BottleCarrier
```python
from pylabrobot.resources import ResourceHolder
from pylabrobot.resources.carrier import create_ordered_items_2d
from unilabos.resources.itemized_carrier import BottleCarrier
from unilabos.registry.decorators import resource
@resource(id="My_6SlotCarrier", category=["bottle_carriers"], description="六槽位载架")
def My_6SlotCarrier(name: str) -> BottleCarrier:
sites = create_ordered_items_2d(
klass=ResourceHolder,
num_items_x=3, num_items_y=2,
dx=10.0, dy=10.0, dz=5.0,
item_dx=42.0, item_dy=35.0,
size_x=20.0, size_y=20.0, size_z=50.0,
)
# 子 site 用 name 作为前缀
for k, v in sites.items():
v.name = f"{name}_{v.name}"
carrier = BottleCarrier(
name=name, size_x=146.0, size_y=80.0, size_z=55.0,
sites=sites, model="My_6SlotCarrier",
)
carrier.num_items_x = 3
carrier.num_items_y = 2
carrier.num_items_z = 1
# 放置 Bottle 时用 name 作为前缀
ordering = ["A1", "B1", "A2", "B2", "A3", "B3"]
for i in range(6):
carrier[i] = My_Reagent_Bottle(f"{name}_vial_{ordering[i]}")
return carrier
```
### WareHouse / Deck 放置位
WareHouse 和 Site 本质上是同一概念都是定义一组固定放置位slot根据物理尺寸自行批量计算偏移坐标。WareHouse 只是多嵌套了一层 Deck 而已。推荐开发者直接根据实物测量数据计算各 slot 偏移量。
#### WareHouse使用 warehouse_factory
```python
from unilabos.resources.warehouse import warehouse_factory
from unilabos.registry.decorators import resource
@resource(id="my_warehouse_4x4", category=["warehouse"], description="4x4 堆栈仓库")
def my_warehouse_4x4(name: str) -> "WareHouse":
return warehouse_factory(
name=name,
num_items_x=4, num_items_y=4, num_items_z=1,
dx=10.0, dy=10.0, dz=10.0, # 第一个 slot 的起始偏移
item_dx=147.0, item_dy=106.0, item_dz=130.0, # slot 间距
resource_size_x=127.0, resource_size_y=85.0, resource_size_z=100.0, # slot 尺寸
model="my_warehouse_4x4",
col_offset=0, # 列标签起始偏移0 → A01, 4 → A05
layout="row-major", # "row-major" 行优先 / "col-major" 列优先 / "vertical-col-major" 竖向
)
```
`warehouse_factory` 参数说明:
- `dx/dy/dz`:第一个 slot 相对 WareHouse 原点的偏移mm
- `item_dx/item_dy/item_dz`:相邻 slot 间距mm需根据实际物理间距测量
- `resource_size_x/y/z`:每个 slot 的可放置区域尺寸
- `layout`:影响 slot 标签和坐标映射
- `"row-major"`A01,A02,...,B01,B02,...(行优先,适合横向排列)
- `"col-major"`A01,B01,...,A02,B02,...(列优先)
- `"vertical-col-major"`竖向排列y 坐标反向
#### Deck 组装 WareHouse
Deck 通过 `setup()` 将多个 WareHouse 放置到指定坐标:
```python
from pylabrobot.resources import Deck, Coordinate
from unilabos.registry.decorators import resource
@resource(id="MyStation_Deck", category=["deck"], description="我的工作站 Deck")
class MyStation_Deck(Deck):
def __init__(self, name="MyStation_Deck", size_x=2700.0, size_y=1080.0, size_z=1500.0,
category="deck", setup=False, **kwargs) -> None:
super().__init__(name=name, size_x=size_x, size_y=size_y, size_z=size_z)
if setup:
self.setup()
def setup(self) -> None:
self.warehouses = {
"堆栈1左": my_warehouse_4x4("堆栈1左"),
"堆栈1右": my_warehouse_4x4("堆栈1右"),
}
self.warehouse_locations = {
"堆栈1左": Coordinate(-200.0, 400.0, 0.0), # 自行测量计算
"堆栈1右": Coordinate(2350.0, 400.0, 0.0),
}
for wh_name, wh in self.warehouses.items():
self.assign_child_resource(wh, location=self.warehouse_locations[wh_name])
```
#### Site 模式(前端定向放置)
适用于有固定孔位/槽位的设备(如移液站 PRCXI 9300Deck 通过 `sites` 列表定义前端展示的放置位,前端据此渲染可拖拽的孔位布局:
```python
import collections
from typing import Any, Dict, List, Optional
from pylabrobot.resources import Deck, Resource, Coordinate
from unilabos.registry.decorators import resource
@resource(id="MyLabDeck", category=["deck"], description="带 Site 定向放置的 Deck")
class MyLabDeck(Deck):
# 根据设备台面实测批量计算各 slot 坐标偏移
_DEFAULT_SITE_POSITIONS = [
(0, 0, 0), (138, 0, 0), (276, 0, 0), (414, 0, 0), # T1-T4
(0, 96, 0), (138, 96, 0), (276, 96, 0), (414, 96, 0), # T5-T8
]
_DEFAULT_SITE_SIZE = {"width": 128.0, "height": 86.0, "depth": 0}
_DEFAULT_CONTENT_TYPE = ["plate", "tip_rack", "tube_rack", "adaptor"]
def __init__(self, name: str, size_x: float, size_y: float, size_z: float,
sites: Optional[List[Dict[str, Any]]] = None, **kwargs):
super().__init__(size_x, size_y, size_z, name)
if sites is not None:
self.sites = [dict(s) for s in sites]
else:
self.sites = []
for i, (x, y, z) in enumerate(self._DEFAULT_SITE_POSITIONS):
self.sites.append({
"label": f"T{i + 1}", # 前端显示的槽位标签
"visible": True, # 是否在前端可见
"position": {"x": x, "y": y, "z": z}, # 槽位物理坐标
"size": dict(self._DEFAULT_SITE_SIZE), # 槽位尺寸
"content_type": list(self._DEFAULT_CONTENT_TYPE), # 允许放入的物料类型
})
self._ordering = collections.OrderedDict(
(site["label"], None) for site in self.sites
)
def assign_child_resource(self, resource: Resource,
location: Optional[Coordinate] = None,
reassign: bool = True,
spot: Optional[int] = None):
idx = spot
if spot is None:
for i, site in enumerate(self.sites):
if site.get("label") == resource.name:
idx = i
break
if idx is None:
for i in range(len(self.sites)):
if self._get_site_resource(i) is None:
idx = i
break
if idx is None:
raise ValueError(f"No available site for '{resource.name}'")
loc = Coordinate(**self.sites[idx]["position"])
super().assign_child_resource(resource, location=loc, reassign=reassign)
def serialize(self) -> dict:
data = super().serialize()
sites_out = []
for i, site in enumerate(self.sites):
occupied = self._get_site_resource(i)
sites_out.append({
"label": site["label"],
"visible": site.get("visible", True),
"occupied_by": occupied.name if occupied else None,
"position": site["position"],
"size": site["size"],
"content_type": site["content_type"],
})
data["sites"] = sites_out
return data
```
**Site 字段说明:**
| 字段 | 类型 | 说明 |
|------|------|------|
| `label` | str | 槽位标签(如 `"T1"`),前端显示名称,也用于匹配 resource.name |
| `visible` | bool | 是否在前端可见 |
| `position` | dict | 物理坐标 `{x, y, z}`mm需自行测量计算偏移 |
| `size` | dict | 槽位尺寸 `{width, height, depth}`mm |
| `content_type` | list | 允许放入的物料类型,如 `["plate", "tip_rack", "tube_rack", "adaptor"]` |
**参考实现:** `unilabos/devices/liquid_handling/prcxi/prcxi.py` 中的 `PRCXI9300Deck`4x4 共 16 个 site
---
## 文件位置
```
unilabos/resources/
├── <project>/ # 按项目分组
│ ├── bottles.py # Bottle 工厂函数
│ ├── bottle_carriers.py # Carrier 工厂函数
│ ├── warehouses.py # WareHouse 工厂函数
│ └── decks.py # Deck 类定义
```
---
## 验证
```bash
# 资源可导入
python -c "from unilabos.resources.my_project.bottles import My_Reagent_Bottle; print(My_Reagent_Bottle('test'))"
# 启动测试AST 自动扫描)
unilab -g <graph>.json
```
仅在以下情况仍需 YAML第三方库资源如 pylabrobot 内置资源,无 `@resource` 装饰器)。
---
## 关键路径
| 内容 | 路径 |
|------|------|
| Bottle/Carrier 基类 | `unilabos/resources/itemized_carrier.py` |
| WareHouse 基类 + 工厂 | `unilabos/resources/warehouse.py` |
| PLR 注册 | `unilabos/resources/plr_additional_res_reg.py` |
| 装饰器定义 | `unilabos/registry/decorators.py` |

View File

@@ -0,0 +1,292 @@
# 资源高级参考
本文件是 SKILL.md 的补充,包含类继承体系、序列化/反序列化、Bioyond 物料同步、非瓶类资源和仓库工厂模式。Agent 在需要实现这些功能时按需阅读。
---
## 1. 类继承体系
```
PyLabRobot
├── Resource (PLR 基类)
│ ├── Well
│ │ └── Bottle (unilabos) → 瓶/小瓶/烧杯/反应器
│ ├── Deck
│ │ └── 自定义 Deck 类 (unilabos) → 工作站台面
│ ├── ResourceHolder → 槽位占位符
│ └── Container
│ └── Battery (unilabos) → 组装好的电池
├── ItemizedCarrier (unilabos, 继承 Resource)
│ ├── BottleCarrier (unilabos) → 瓶载架
│ └── WareHouse (unilabos) → 堆栈仓库
├── ItemizedResource (PLR)
│ └── MagazineHolder (unilabos) → 子弹夹载架
└── ResourceStack (PLR)
└── Magazine (unilabos) → 子弹夹洞位
```
### Bottle 类细节
```python
class Bottle(Well):
def __init__(self, name, diameter, height, max_volume,
size_x=0.0, size_y=0.0, size_z=0.0,
barcode=None, category="container", model=None, **kwargs):
super().__init__(
name=name,
size_x=diameter, # PLR 用 diameter 作为 size_x/size_y
size_y=diameter,
size_z=height, # PLR 用 height 作为 size_z
max_volume=max_volume,
category=category,
model=model,
bottom_type="flat",
cross_section_type="circle"
)
```
注意 `size_x = size_y = diameter``size_z = height`
### ItemizedCarrier 核心方法
| 方法 | 说明 |
|------|------|
| `__getitem__(identifier)` | 通过索引或 Excel 标识(如 `"A01"`)访问槽位 |
| `__setitem__(identifier, resource)` | 向槽位放入资源 |
| `get_child_identifier(child)` | 获取子资源的标识符 |
| `capacity` | 总槽位数 |
| `sites` | 所有槽位字典 |
---
## 2. 序列化与反序列化
### PLR ↔ UniLab 转换
| 函数 | 位置 | 方向 |
|------|------|------|
| `ResourceTreeSet.from_plr_resources(resources)` | `resource_tracker.py` | PLR → UniLab |
| `ResourceTreeSet.to_plr_resources()` | `resource_tracker.py` | UniLab → PLR |
### `from_plr_resources` 流程
```
PLR Resource
↓ build_uuid_mapping (递归生成 UUID)
↓ resource.serialize() → dict
↓ resource.serialize_all_state() → states
↓ resource_plr_inner (递归构建 ResourceDictInstance)
ResourceTreeSet
```
关键:每个 PLR 资源通过 `unilabos_uuid` 属性携带 UUID`unilabos_extra` 携带扩展数据(如 `class` 名)。
### `to_plr_resources` 流程
```
ResourceTreeSet
↓ collect_node_data (收集 UUID、状态、扩展数据)
↓ node_to_plr_dict (转为 PLR 字典格式)
↓ find_subclass(type_name, PLRResource) (查找 PLR 子类)
↓ sub_cls.deserialize(plr_dict) (反序列化)
↓ loop_set_uuid, loop_set_extra (递归设置 UUID 和扩展)
PLR Resource
```
### Bottle 序列化
```python
class Bottle(Well):
def serialize(self) -> dict:
data = super().serialize()
return {**data, "diameter": self.diameter, "height": self.height}
@classmethod
def deserialize(cls, data: dict, allow_marshal=False):
barcode_data = data.pop("barcode", None)
instance = super().deserialize(data, allow_marshal=allow_marshal)
if barcode_data and isinstance(barcode_data, str):
instance.barcode = barcode_data
return instance
```
---
## 3. Bioyond 物料同步
### 双向转换函数
| 函数 | 位置 | 方向 |
|------|------|------|
| `resource_bioyond_to_plr(materials, type_mapping, deck)` | `graphio.py` | Bioyond → PLR |
| `resource_plr_to_bioyond(resources, type_mapping, warehouse_mapping)` | `graphio.py` | PLR → Bioyond |
### `resource_bioyond_to_plr` 流程
```
Bioyond 物料列表
↓ reverse_type_mapping: {typeName → (model, UUID)}
↓ 对每个物料:
typeName → 查映射 → model (如 "BIOYOND_PolymerStation_Reactor")
initialize_resource({"name": unique_name, "class": model})
↓ 设置 unilabos_extra (material_bioyond_id, material_bioyond_name 等)
↓ 处理 detail (子物料/坐标)
↓ 按 locationName 放入 deck.warehouses 对应槽位
PLR 资源列表
```
### `resource_plr_to_bioyond` 流程
```
PLR 资源列表
↓ 遍历每个资源:
载架(capacity > 1): 生成 details 子物料 + 坐标
单瓶: 直接映射
↓ type_mapping 查找 typeId
↓ warehouse_mapping 查找位置 UUID
↓ 组装 Bioyond 格式 (name, typeName, typeId, quantity, Parameters, locations)
Bioyond 物料列表
```
### BioyondResourceSynchronizer
工作站通过 `ResourceSynchronizer` 自动同步物料:
```python
class BioyondResourceSynchronizer(ResourceSynchronizer):
def sync_from_external(self) -> bool:
all_data = []
all_data.extend(api_client.stock_material('{"typeMode": 0}')) # 耗材
all_data.extend(api_client.stock_material('{"typeMode": 1}')) # 样品
all_data.extend(api_client.stock_material('{"typeMode": 2}')) # 试剂
unilab_resources = resource_bioyond_to_plr(
all_data,
type_mapping=self.workstation.bioyond_config["material_type_mappings"],
deck=self.workstation.deck
)
# 更新 deck 上的资源
```
---
## 4. 非瓶类资源
### ElectrodeSheet极片
路径:`unilabos/resources/battery/electrode_sheet.py`
```python
class ElectrodeSheet(ResourcePLR):
"""片状材料(极片、隔膜、弹片、垫片等)"""
_unilabos_state = {
"diameter": 0.0,
"thickness": 0.0,
"mass": 0.0,
"material_type": "",
"color": "",
"info": "",
}
```
工厂函数:`PositiveCan`, `PositiveElectrode`, `NegativeCan`, `NegativeElectrode`, `SpringWasher`, `FlatWasher`, `AluminumFoil`
### Battery电池
```python
class Battery(Container):
"""组装好的电池"""
_unilabos_state = {
"color": "",
"electrolyte_name": "",
"open_circuit_voltage": 0.0,
}
```
### Magazine / MagazineHolder子弹夹
```python
class Magazine(ResourceStack):
"""子弹夹洞位,可堆叠 ElectrodeSheet"""
# direction, max_sheets
class MagazineHolder(ItemizedResource):
"""多洞位子弹夹"""
# hole_diameter, hole_depth, max_sheets_per_hole
```
工厂函数 `magazine_factory()``create_homogeneous_resources` 生成洞位,可选预填 `ElectrodeSheet``Battery`
---
## 5. 仓库工厂模式参考
### 实际 warehouse 工厂函数示例
```python
# 行优先 4x4 仓库
def bioyond_warehouse_1x4x4(name: str) -> WareHouse:
return warehouse_factory(
name=name,
num_items_x=4, num_items_y=4, num_items_z=1,
dx=10.0, dy=10.0, dz=10.0,
item_dx=147.0, item_dy=106.0, item_dz=130.0,
layout="row-major", # A01,A02,A03,A04, B01,...
)
# 右侧 4x4 仓库(列名偏移)
def bioyond_warehouse_1x4x4_right(name: str) -> WareHouse:
return warehouse_factory(
name=name,
num_items_x=4, num_items_y=4, num_items_z=1,
dx=10.0, dy=10.0, dz=10.0,
item_dx=147.0, item_dy=106.0, item_dz=130.0,
col_offset=4, # A05,A06,A07,A08
layout="row-major",
)
# 竖向仓库(站内试剂存放)
def bioyond_warehouse_reagent_storage(name: str) -> WareHouse:
return warehouse_factory(
name=name,
num_items_x=1, num_items_y=2, num_items_z=1,
dx=10.0, dy=10.0, dz=10.0,
item_dx=147.0, item_dy=106.0, item_dz=130.0,
layout="vertical-col-major",
)
# 行偏移F 行开始)
def bioyond_warehouse_5x3x1(name: str, row_offset: int = 0) -> WareHouse:
return warehouse_factory(
name=name,
num_items_x=3, num_items_y=5, num_items_z=1,
dx=10.0, dy=10.0, dz=10.0,
item_dx=159.0, item_dy=183.0, item_dz=130.0,
row_offset=row_offset, # 0→A行起5→F行起
layout="row-major",
)
```
### layout 类型说明
| layout | 命名顺序 | 适用场景 |
|--------|---------|---------|
| `col-major` (默认) | A01,B01,C01,D01, A02,B02,... | 列优先,标准堆栈 |
| `row-major` | A01,A02,A03,A04, B01,B02,... | 行优先Bioyond 前端展示 |
| `vertical-col-major` | 竖向排列,标签从底部开始 | 竖向仓库(试剂存放、测密度) |
---
## 6. 关键路径
| 内容 | 路径 |
|------|------|
| Bottle/Carrier 基类 | `unilabos/resources/itemized_carrier.py` |
| WareHouse 类 + 工厂 | `unilabos/resources/warehouse.py` |
| ResourceTreeSet 转换 | `unilabos/resources/resource_tracker.py` |
| Bioyond 物料转换 | `unilabos/resources/graphio.py` |
| Bioyond 仓库定义 | `unilabos/resources/bioyond/warehouses.py` |
| 电池资源 | `unilabos/resources/battery/` |
| PLR 注册 | `unilabos/resources/plr_additional_res_reg.py` |

View File

@@ -0,0 +1,626 @@
---
name: add-workstation
description: Guide for adding new workstations to Uni-Lab-OS (接入新工作站). Uses @device decorator + AST auto-scanning. Walks through workstation type, sub-device composition, driver creation, deck setup, and graph file. Use when the user wants to add a workstation, create a workstation driver, configure a station with sub-devices, or mentions 工作站/工站/station/workstation.
---
# Uni-Lab-OS 工作站接入指南
工作站workstation是组合多个子设备的大型设备拥有独立的物料管理系统和工作流引擎。使用 `@device` 装饰器注册AST 自动扫描生成注册表。
---
## 工作站类型
| 类型 | 基类 | 适用场景 |
| ------------------- | ----------------- | ---------------------------------- |
| **Protocol 工作站** | `ProtocolNode` | 标准化学操作协议(泵转移、过滤等) |
| **外部系统工作站** | `WorkstationBase` | 与外部 LIMS/MES 对接 |
| **硬件控制工作站** | `WorkstationBase` | 直接控制 PLC/硬件 |
---
## @device 装饰器(工作站)
工作站也使用 `@device` 装饰器注册,参数与普通设备一致:
```python
@device(
id="my_workstation", # 注册表唯一标识(必填)
category=["workstation"], # 分类标签
description="我的工作站",
)
```
如果一个工作站类支持多个具体变体,可使用 `ids` / `id_meta`,与设备的用法相同(参见 add-device SKILL
---
## 工作站驱动模板
### 模板 A基于外部系统的工作站
```python
import logging
from typing import Dict, Any, Optional
from pylabrobot.resources import Deck
from unilabos.registry.decorators import device, topic_config, not_action
from unilabos.devices.workstation.workstation_base import WorkstationBase
try:
from unilabos.ros.nodes.presets.workstation import ROS2WorkstationNode
except ImportError:
ROS2WorkstationNode = None
@device(id="my_workstation", category=["workstation"], description="我的工作站")
class MyWorkstation(WorkstationBase):
_ros_node: "ROS2WorkstationNode"
def __init__(self, config=None, deck=None, protocol_type=None, **kwargs):
super().__init__(deck=deck, **kwargs)
self.config = config or {}
self.logger = logging.getLogger("MyWorkstation")
self.api_host = self.config.get("api_host", "")
self._status = "Idle"
@not_action
def post_init(self, ros_node: "ROS2WorkstationNode"):
super().post_init(ros_node)
self._ros_node = ros_node
async def scheduler_start(self, **kwargs) -> Dict[str, Any]:
"""注册为工作站动作"""
return {"success": True}
async def create_order(self, json_str: str, **kwargs) -> Dict[str, Any]:
"""注册为工作站动作"""
return {"success": True}
@property
@topic_config()
def workflow_sequence(self) -> str:
return "[]"
@property
@topic_config()
def material_info(self) -> str:
return "{}"
```
### 模板 BProtocol 工作站
直接使用 `ProtocolNode`,通常不需要自定义驱动类:
```python
from unilabos.devices.workstation.workstation_base import ProtocolNode
```
在图文件中配置 `protocol_type` 即可。
---
## 子设备访问sub_devices
工站初始化子设备后,所有子设备实例存储在 `self._ros_node.sub_devices` 字典中key 为设备 idvalue 为 `ROS2DeviceNode` 实例)。工站的驱动类可以直接获取子设备实例来调用其方法:
```python
# 在工站驱动类的方法中访问子设备
sub = self._ros_node.sub_devices["pump_1"]
# .driver_instance — 子设备的驱动实例(即设备 Python 类的实例)
sub.driver_instance.some_method(arg1, arg2)
# .ros_node_instance — 子设备的 ROS2 节点实例
sub.ros_node_instance._action_value_mappings # 查看子设备支持的 action
```
**常见用法**
```python
class MyWorkstation(WorkstationBase):
def my_protocol(self, **kwargs):
# 获取子设备驱动实例
pump = self._ros_node.sub_devices["pump_1"].driver_instance
heater = self._ros_node.sub_devices["heater_1"].driver_instance
# 直接调用子设备方法
pump.aspirate(volume=100)
heater.set_temperature(80)
```
> 参考实现:`unilabos/devices/workstation/bioyond_studio/reaction_station/reaction_station.py` 中通过 `self._ros_node.sub_devices.get(reactor_id)` 获取子反应器实例并更新数据。
---
## 硬件通信接口hardware_interface
硬件控制型工作站通常需要通过串口Serial、Modbus 等通信协议控制多个子设备。Uni-Lab-OS 通过 **通信设备代理** 机制实现端口共享:一个串口只创建一个 `serial` 节点,多个子设备共享这个通信实例。
### 工作原理
`ROS2WorkstationNode` 初始化时分两轮遍历子设备(`workstation.py`
**第一轮 — 初始化所有子设备**:按 `children` 顺序调用 `initialize_device()`,通信设备(`serial_` / `io_` 开头的 id优先完成初始化创建 `serial.Serial()` 实例。其他子设备此时 `self.hardware_interface = "serial_pump"`(字符串)。
**第二轮 — 代理替换**:遍历所有已初始化的子设备,读取子设备的 `_hardware_interface` 配置:
```
hardware_interface = d.ros_node_instance._hardware_interface
# → {"name": "hardware_interface", "read": "send_command", "write": "send_command"}
```
1.`name` 字段对应的属性值:`name_value = getattr(driver, hardware_interface["name"])`
- 如果 `name_value` 是字符串且该字符串是某个子设备的 id → 触发代理替换
2. 从通信设备获取真正的 `read`/`write` 方法
3.`setattr(driver, read_method, _read)` 将通信设备的方法绑定到子设备上
因此:
- **通信设备 id 必须与子设备 config 中填的字符串完全一致**(如 `"serial_pump"`
- **通信设备 id 必须以 `serial_``io_` 开头**(否则第一轮不会被识别为通信设备)
- **通信设备必须在 `children` 列表中排在最前面**,确保先初始化
### HardwareInterface 参数说明
```python
from unilabos.registry.decorators import HardwareInterface
HardwareInterface(
name="hardware_interface", # __init__ 中接收通信实例的属性名
read="send_command", # 通信设备上暴露的读方法名
write="send_command", # 通信设备上暴露的写方法名
extra_info=["list_ports"], # 可选:额外暴露的方法
)
```
**`name` 字段的含义**:对应设备类 `__init__` 中,用于保存通信实例的**属性名**。系统据此知道要替换哪个属性。大部分设备直接用 `"hardware_interface"`,也可以自定义(如 `"io_device_port"`)。
### 示例 1name="hardware_interface"
```python
from unilabos.registry.decorators import device, HardwareInterface
@device(
id="my_pump",
category=["pump_and_valve"],
hardware_interface=HardwareInterface(
name="hardware_interface",
read="send_command",
write="send_command",
),
)
class MyPump:
def __init__(self, port=None, address="1", **kwargs):
# name="hardware_interface" → 系统替换 self.hardware_interface
self.hardware_interface = port # 初始为字符串 "serial_pump",启动后被替换为 Serial 实例
self.address = address
def send_command(self, command: str):
full_command = f"/{self.address}{command}\r\n"
self.hardware_interface.write(bytearray(full_command, "ascii"))
return self.hardware_interface.read_until(b"\n")
```
### 示例 2电磁阀name="io_device_port",自定义属性名)
```python
@device(
id="solenoid_valve",
category=["pump_and_valve"],
hardware_interface=HardwareInterface(
name="io_device_port", # 自定义属性名 → 系统替换 self.io_device_port
read="read_io_coil",
write="write_io_coil",
),
)
class SolenoidValve:
def __init__(self, io_device_port: str = None, **kwargs):
# name="io_device_port" → 图文件 config 中用 "io_device_port": "io_board_1"
self.io_device_port = io_device_port # 初始为字符串,系统替换为 Modbus 实例
```
### Serial 通信设备class="serial"
`serial` 是 Uni-Lab-OS 内置的通信代理设备,代码位于 `unilabos/ros/nodes/presets/serial_node.py`
```python
from serial import Serial, SerialException
from threading import Lock
class ROS2SerialNode(BaseROS2DeviceNode):
def __init__(self, device_id, registry_name, port: str, baudrate: int = 9600, **kwargs):
self.port = port
self.baudrate = baudrate
self._hardware_interface = {
"name": "hardware_interface",
"write": "send_command",
"read": "read_data",
}
self._query_lock = Lock()
self.hardware_interface = Serial(baudrate=baudrate, port=port)
BaseROS2DeviceNode.__init__(
self, driver_instance=self, registry_name=registry_name,
device_id=device_id, status_types={}, action_value_mappings={},
hardware_interface=self._hardware_interface, print_publish=False,
)
self.create_service(SerialCommand, "serialwrite", self.handle_serial_request)
def send_command(self, command: str):
with self._query_lock:
self.hardware_interface.write(bytearray(f"{command}\n", "ascii"))
return self.hardware_interface.read_until(b"\n").decode()
def read_data(self):
with self._query_lock:
return self.hardware_interface.read_until(b"\n").decode()
```
在图文件中使用 `"class": "serial"` 即可创建串口代理:
```json
{
"id": "serial_pump",
"class": "serial",
"parent": "my_station",
"config": { "port": "COM7", "baudrate": 9600 }
}
```
### 图文件配置
**通信设备必须在 `children` 列表中排在最前面**,确保先于其他子设备初始化:
```json
{
"nodes": [
{
"id": "my_station",
"class": "workstation",
"children": ["serial_pump", "pump_1", "pump_2"],
"config": { "protocol_type": ["PumpTransferProtocol"] }
},
{
"id": "serial_pump",
"class": "serial",
"parent": "my_station",
"config": { "port": "COM7", "baudrate": 9600 }
},
{
"id": "pump_1",
"class": "syringe_pump_with_valve.runze.SY03B-T08",
"parent": "my_station",
"config": { "port": "serial_pump", "address": "1", "max_volume": 25.0 }
},
{
"id": "pump_2",
"class": "syringe_pump_with_valve.runze.SY03B-T08",
"parent": "my_station",
"config": { "port": "serial_pump", "address": "2", "max_volume": 25.0 }
}
],
"links": [
{
"source": "pump_1",
"target": "serial_pump",
"type": "communication",
"port": { "pump_1": "port", "serial_pump": "port" }
},
{
"source": "pump_2",
"target": "serial_pump",
"type": "communication",
"port": { "pump_2": "port", "serial_pump": "port" }
}
]
}
```
### 通信协议速查
| 协议 | config 参数 | 依赖包 | 通信设备 class |
| -------------------- | ------------------------------ | ---------- | -------------------------- |
| Serial (RS232/RS485) | `port`, `baudrate` | `pyserial` | `serial` |
| Modbus RTU | `port`, `baudrate`, `slave_id` | `pymodbus` | `device_comms/modbus_plc/` |
| Modbus TCP | `host`, `port`, `slave_id` | `pymodbus` | `device_comms/modbus_plc/` |
| TCP Socket | `host`, `port` | stdlib | 自定义 |
| HTTP API | `url`, `token` | `requests` | `device_comms/rpc.py` |
参考实现:`unilabos/test/experiments/Grignard_flow_batchreact_single_pumpvalve.json`
---
## Deck 与物料生命周期
### 1. Deck 入参与两种初始化模式
系统根据设备节点 `config.deck` 的写法,自动反序列化 Deck 实例后传入 `__init__``deck` 参数。目前 `deck` 是固定字段名,只支持一个主 Deck。建议一个设备拥有一个台面台面上抽象二级、三级子物料。
有两种初始化模式:
#### init 初始化(推荐)
`config.deck` 直接包含 `_resource_type` + `_resource_child_name`,系统先用 Deck 节点的 `config` 调用 Deck 类的 `__init__` 反序列化,再将实例传入设备的 `deck` 参数。子物料随 Deck 的 `children` 一起反序列化。
```json
"config": {
"deck": {
"_resource_type": "unilabos.devices.liquid_handling.prcxi.prcxi:PRCXI9300Deck",
"_resource_child_name": "PRCXI_Deck"
}
}
```
#### deserialize 初始化
`config.deck``data` 包裹一层,系统走 `deserialize` 路径,可传入更多参数(如 `allow_marshal` 等):
```json
"config": {
"deck": {
"data": {
"_resource_child_name": "YB_Bioyond_Deck",
"_resource_type": "unilabos.resources.bioyond.decks:BIOYOND_YB_Deck"
}
}
}
```
没有特殊需求时推荐 init 初始化。
#### config.deck 字段说明
| 字段 | 说明 |
|------|------|
| `_resource_type` | Deck 类的完整模块路径(`module:ClassName` |
| `_resource_child_name` | 对应图文件中 Deck 节点的 `id`,建立父子关联 |
#### 设备 __init__ 接收
```python
def __init__(self, config=None, deck=None, protocol_type=None, **kwargs):
super().__init__(deck=deck, **kwargs)
# deck 已经是反序列化后的 Deck 实例
# → PRCXI9300Deck / BIOYOND_YB_Deck 等
```
#### Deck 节点(图文件中)
Deck 节点作为设备的 `children` 之一,`parent` 指向设备 id
```json
{
"id": "PRCXI_Deck",
"parent": "PRCXI",
"type": "deck",
"class": "",
"children": [],
"config": {
"type": "PRCXI9300Deck",
"size_x": 542, "size_y": 374, "size_z": 0,
"category": "deck",
"sites": [...]
},
"data": {}
}
```
- `config` 中的字段会传入 Deck 类的 `__init__`(因此 `__init__` 必须能接受所有 `serialize()` 输出的字段)
- `children` 初始为空时,由同步器或手动初始化填充
- `config.type` 填 Deck 类名
### 2. Deck 为空时自行初始化
如果 Deck 节点的 `children` 为空,工作站需在 `post_init` 或首次同步时自行初始化内容:
```python
@not_action
def post_init(self, ros_node):
super().post_init(ros_node)
if self.deck and not self.deck.children:
self._initialize_default_deck()
def _initialize_default_deck(self):
from my_labware import My_TipRack, My_Plate
self.deck.assign_child_resource(My_TipRack("T1"), spot=0)
self.deck.assign_child_resource(My_Plate("T2"), spot=1)
```
### 3. 物料双向同步
当工作站对接外部系统LIMS/MES需要实现 `ResourceSynchronizer` 处理双向物料同步:
```python
from unilabos.devices.workstation.workstation_base import ResourceSynchronizer
class MyResourceSynchronizer(ResourceSynchronizer):
def sync_from_external(self) -> bool:
"""从外部系统同步到 self.workstation.deck"""
external_data = self._query_external_materials()
# 以外部工站为准:根据外部数据反向创建 PLR 资源实例
for item in external_data:
cls = self._resolve_resource_class(item["type"])
resource = cls(name=item["name"], **item["params"])
self.workstation.deck.assign_child_resource(resource, spot=item["slot"])
return True
def sync_to_external(self, resource) -> bool:
"""将 UniLab 侧物料变更同步到外部系统"""
# 以 UniLab 为准:将 PLR 资源转为外部格式并推送
external_format = self._convert_to_external(resource)
return self._push_to_external(external_format)
def handle_external_change(self, change_info) -> bool:
"""处理外部系统主动推送的变更"""
return True
```
同步策略取决于业务场景:
- **以外部工站为准**:从外部 API 查询物料数据,反向创建对应的 PLR 资源实例放到 Deck 上
- **以 UniLab 为准**UniLab 侧的物料变更通过 `sync_to_external` 推送到外部系统
在工作站 `post_init` 中初始化同步器:
```python
@not_action
def post_init(self, ros_node):
super().post_init(ros_node)
self.resource_synchronizer = MyResourceSynchronizer(self)
self.resource_synchronizer.sync_from_external()
```
### 4. 序列化与持久化serialize / serialize_state
资源类需正确实现序列化,系统据此完成持久化和前端同步。
**`serialize()`** — 输出资源的结构信息(`config` 层),反序列化时作为 `__init__` 的入参回传。因此 **`__init__` 必须通过 `**kwargs`接受`serialize()` 输出的所有字段\*\*,即使当前不使用:
```python
class MyDeck(Deck):
def __init__(self, name, size_x, size_y, size_z,
sites=None, # serialize() 输出的字段
rotation=None, # serialize() 输出的字段
barcode=None, # serialize() 输出的字段
**kwargs): # 兜底:接受所有未知的 serialize 字段
super().__init__(size_x, size_y, size_z, name)
# ...
def serialize(self) -> dict:
data = super().serialize()
data["sites"] = [...] # 自定义字段
return data
```
**`serialize_state()`** — 输出资源的运行时状态(`data` 层),用于持久化可变信息。`data` 中的内容会被正确保存和恢复:
```python
class MyPlate(Plate):
def __init__(self, name, size_x, size_y, size_z,
material_info=None, **kwargs):
super().__init__(name, size_x, size_y, size_z, **kwargs)
self._unilabos_state = {}
if material_info:
self._unilabos_state["Material"] = material_info
def serialize_state(self) -> Dict[str, Any]:
data = super().serialize_state()
data.update(self._unilabos_state)
return data
```
关键要点:
- `serialize()` 输出的所有字段都会作为 `config` 回传到 `__init__`,所以 `__init__` 必须能接受它们(显式声明或 `**kwargs`
- `serialize_state()` 输出的 `data` 用于持久化运行时状态(如物料信息、液体量等)
- `_unilabos_state` 中只存可 JSON 序列化的基本类型str, int, float, bool, list, dict, None
### 5. 子物料自动同步
子物料Bottle、Plate、TipRack 等)放到 Deck 上后,系统会自动将其同步到前端的 Deck 视图。只需保证资源类正确实现了 `serialize()` / `serialize_state()` 和反序列化即可。
### 6. 图文件配置(参考 prcxi_9320_slim.json
```json
{
"nodes": [
{
"id": "my_station",
"type": "device",
"class": "my_workstation",
"config": {
"deck": {
"_resource_type": "unilabos.resources.my_module:MyDeck",
"_resource_child_name": "my_deck"
},
"host": "10.20.30.1",
"port": 9999
}
},
{
"id": "my_deck",
"parent": "my_station",
"type": "deck",
"class": "",
"children": [],
"config": {
"type": "MyLabDeck",
"size_x": 542,
"size_y": 374,
"size_z": 0,
"category": "deck",
"sites": [
{
"label": "T1",
"visible": true,
"occupied_by": null,
"position": { "x": 0, "y": 0, "z": 0 },
"size": { "width": 128.0, "height": 86, "depth": 0 },
"content_type": ["plate", "tip_rack", "tube_rack", "adaptor"]
}
]
},
"data": {}
}
],
"edges": []
}
```
Deck 节点要点:
- `config.type` 填 Deck 类名(如 `"PRCXI9300Deck"`
- `config.sites` 完整列出所有 site从 Deck 类的 `serialize()` 输出获取)
- `children` 初始为空(由同步器或手动初始化填充)
- 设备节点 `config.deck._resource_type` 指向 Deck 类的完整模块路径
---
## 子设备
子设备按标准设备接入流程创建(参见 add-device SKILL使用 `@device` 装饰器。
子设备约束:
- 图文件中 `parent` 指向工作站 ID
- 在工作站 `children` 数组中列出
---
## 关键规则
1. **`__init__` 必须接受 `deck``**kwargs`** — `WorkstationBase.**init**`需要`deck` 参数
2. **Deck 通过 `config.deck._resource_type` 反序列化传入** — 不要在 `__init__` 中手动创建 Deck
3. **Deck 为空时自行初始化内容** — 在 `post_init` 中检查并填充默认物料
4. **外部同步实现 `ResourceSynchronizer`**`sync_from_external` / `sync_to_external`
5. **通过 `self._children` 访问子设备** — 不要自行维护子设备引用
6. **`post_init` 中启动后台服务** — 不要在 `__init__` 中启动网络连接
7. **异步方法使用 `await self._ros_node.sleep()`** — 禁止 `time.sleep()``asyncio.sleep()`
8. **使用 `@not_action` 标记非动作方法**`post_init`, `initialize`, `cleanup`
9. **子物料保证正确 serialize/deserialize** — 系统自动同步到前端 Deck 视图
---
## 验证
```bash
# 模块可导入
python -c "from unilabos.devices.workstation.<name>.<name> import <ClassName>"
# 启动测试AST 自动扫描)
unilab -g <graph>.json
```
---
## 现有工作站参考
| 工作站 | 驱动类 | 类型 |
| -------------- | ----------------------------- | -------- |
| Protocol 通用 | `ProtocolNode` | Protocol |
| Bioyond 反应站 | `BioyondReactionStation` | 外部系统 |
| 纽扣电池组装 | `CoinCellAssemblyWorkstation` | 硬件控制 |
参考路径:`unilabos/devices/workstation/` 目录下各工作站实现。

View File

@@ -0,0 +1,371 @@
# 工作站高级模式参考
本文件是 SKILL.md 的补充,包含外部系统集成、物料同步、配置结构等高级模式。
Agent 在需要实现这些功能时按需阅读。
---
## 1. 外部系统集成模式
### 1.1 RPC 客户端
与外部 LIMS/MES 系统通信的标准模式。继承 `BaseRequest`,所有接口统一用 POST。
```python
from unilabos.device_comms.rpc import BaseRequest
class MySystemRPC(BaseRequest):
"""外部系统 RPC 客户端"""
def __init__(self, host: str, api_key: str):
super().__init__(host)
self.api_key = api_key
def _request(self, endpoint: str, data: dict = None) -> dict:
return self.post(
url=f"{self.host}/api/{endpoint}",
params={
"apiKey": self.api_key,
"requestTime": self.get_current_time_iso8601(),
"data": data or {},
},
)
def query_status(self) -> dict:
return self._request("status/query")
def create_order(self, order_data: dict) -> dict:
return self._request("order/create", order_data)
```
参考:`unilabos/devices/workstation/bioyond_studio/bioyond_rpc.py``BioyondV1RPC`
### 1.2 HTTP 回调服务
接收外部系统报送的标准模式。使用 `WorkstationHTTPService`,在 `post_init` 中启动。
```python
from unilabos.devices.workstation.workstation_http_service import WorkstationHTTPService
class MyWorkstation(WorkstationBase):
def __init__(self, config=None, deck=None, **kwargs):
super().__init__(deck=deck, **kwargs)
self.config = config or {}
http_cfg = self.config.get("http_service_config", {})
self._http_service_config = {
"host": http_cfg.get("http_service_host", "127.0.0.1"),
"port": http_cfg.get("http_service_port", 8080),
}
self.http_service = None
def post_init(self, ros_node):
super().post_init(ros_node)
self.http_service = WorkstationHTTPService(
workstation_instance=self,
host=self._http_service_config["host"],
port=self._http_service_config["port"],
)
self.http_service.start()
```
**HTTP 服务路由**(固定端点,由 `WorkstationHTTPHandler` 自动分发):
| 端点 | 调用的工作站方法 |
|------|-----------------|
| `/report/step_finish` | `process_step_finish_report(report_request)` |
| `/report/sample_finish` | `process_sample_finish_report(report_request)` |
| `/report/order_finish` | `process_order_finish_report(report_request, used_materials)` |
| `/report/material_change` | `process_material_change_report(report_data)` |
| `/report/error_handling` | `handle_external_error(error_data)` |
实现对应方法即可接收回调:
```python
def process_step_finish_report(self, report_request) -> Dict[str, Any]:
"""处理步骤完成报告"""
step_name = report_request.data.get("stepName")
return {"success": True, "message": f"步骤 {step_name} 已处理"}
def process_order_finish_report(self, report_request, used_materials) -> Dict[str, Any]:
"""处理订单完成报告"""
order_code = report_request.data.get("orderCode")
return {"success": True}
```
参考:`unilabos/devices/workstation/workstation_http_service.py`
### 1.3 连接监控
独立线程周期性检测外部系统连接状态,状态变化时发布 ROS 事件。
```python
class ConnectionMonitor:
def __init__(self, workstation, check_interval=30):
self.workstation = workstation
self.check_interval = check_interval
self._running = False
self._thread = None
def start(self):
self._running = True
self._thread = threading.Thread(target=self._monitor_loop, daemon=True)
self._thread.start()
def _monitor_loop(self):
while self._running:
try:
# 调用外部系统接口检测连接
self.workstation.hardware_interface.ping()
status = "online"
except Exception:
status = "offline"
time.sleep(self.check_interval)
```
参考:`unilabos/devices/workstation/bioyond_studio/station.py``ConnectionMonitor`
---
## 2. Config 结构模式
工作站的 `config` 在图文件中定义,传入 `__init__`。以下是常见字段模式:
### 2.1 外部系统连接
```json
{
"api_host": "http://192.168.1.100:8080",
"api_key": "YOUR_API_KEY"
}
```
### 2.2 HTTP 回调服务
```json
{
"http_service_config": {
"http_service_host": "127.0.0.1",
"http_service_port": 8080
}
}
```
### 2.3 物料类型映射
将 PLR 资源类名映射到外部系统的物料类型(名称 + UUID。用于双向物料转换。
```json
{
"material_type_mappings": {
"PLR_ResourceClassName": ["外部系统显示名", "external-type-uuid"],
"BIOYOND_PolymerStation_Reactor": ["反应器", "3a14233b-902d-0d7b-..."]
}
}
```
### 2.4 仓库映射
将仓库名映射到外部系统的仓库 UUID 和库位 UUID。用于入库/出库操作。
```json
{
"warehouse_mapping": {
"仓库名": {
"uuid": "warehouse-uuid",
"site_uuids": {
"A01": "site-uuid-A01",
"A02": "site-uuid-A02"
}
}
}
}
```
### 2.5 工作流映射
将内部工作流名映射到外部系统的工作流 ID。
```json
{
"workflow_mappings": {
"internal_workflow_name": "external-workflow-uuid"
}
}
```
### 2.6 物料默认参数
```json
{
"material_default_parameters": {
"NMP": {
"unit": "毫升",
"density": "1.03",
"densityUnit": "g/mL",
"description": "N-甲基吡咯烷酮"
}
}
}
```
---
## 3. 资源同步机制
### 3.1 ResourceSynchronizer
抽象基类,用于与外部物料系统双向同步。定义在 `workstation_base.py`
```python
from unilabos.devices.workstation.workstation_base import ResourceSynchronizer
class MyResourceSynchronizer(ResourceSynchronizer):
def __init__(self, workstation, api_client):
super().__init__(workstation)
self.api_client = api_client
def sync_from_external(self) -> bool:
"""从外部系统拉取物料到 deck"""
external_materials = self.api_client.list_materials()
for material in external_materials:
plr_resource = self._convert_to_plr(material)
self.workstation.deck.assign_child_resource(plr_resource, coordinate)
return True
def sync_to_external(self, plr_resource) -> bool:
"""将 deck 中的物料变更推送到外部系统"""
external_data = self._convert_from_plr(plr_resource)
self.api_client.update_material(external_data)
return True
def handle_external_change(self, change_info) -> bool:
"""处理外部系统推送的物料变更"""
return True
```
### 3.2 update_resource — 上传资源树到云端
将 PLR Deck 序列化后通过 ROS 服务上传。典型使用场景:
```python
# 在 post_init 中上传初始 deck
from unilabos.ros.nodes.base_device_node import ROS2DeviceNode
ROS2DeviceNode.run_async_func(
self._ros_node.update_resource, True,
**{"resources": [self.deck]}
)
# 在动作方法中更新特定资源
ROS2DeviceNode.run_async_func(
self._ros_node.update_resource, True,
**{"resources": [updated_plate]}
)
```
---
## 4. 工作流序列管理
工作站通过 `workflow_sequence` 属性管理任务队列JSON 字符串形式)。
```python
class MyWorkstation(WorkstationBase):
def __init__(self, **kwargs):
super().__init__(**kwargs)
self._workflow_sequence = []
@property
def workflow_sequence(self) -> str:
"""返回 JSON 字符串ROS 自动发布"""
import json
return json.dumps(self._workflow_sequence)
async def append_to_workflow_sequence(self, workflow_name: str) -> Dict[str, Any]:
"""添加工作流到队列"""
self._workflow_sequence.append({
"name": workflow_name,
"status": "pending",
"created_at": time.time(),
})
return {"success": True}
async def clear_workflows(self) -> Dict[str, Any]:
"""清空工作流队列"""
self._workflow_sequence = []
return {"success": True}
```
---
## 5. 站间物料转移
工作站之间转移物料的模式。通过 ROS ActionClient 调用目标站的动作。
```python
async def transfer_materials_to_another_station(
self,
target_device_id: str,
transfer_groups: list,
**kwargs,
) -> Dict[str, Any]:
"""将物料转移到另一个工作站"""
target_node = self._children.get(target_device_id)
if not target_node:
# 通过 ROS 节点查找非子设备的目标站
pass
for group in transfer_groups:
resource = self.find_resource_by_name(group["resource_name"])
# 从本站 deck 移除
resource.unassign()
# 调用目标站的接收方法
# ...
return {"success": True, "transferred": len(transfer_groups)}
```
参考:`BioyondDispensingStation.transfer_materials_to_reaction_station`
---
## 6. post_init 完整模式
`post_init` 是工作站初始化的关键阶段,此时 ROS 节点和子设备已就绪。
```python
def post_init(self, ros_node):
super().post_init(ros_node)
# 1. 初始化外部系统客户端(此时 config 已可用)
self.rpc_client = MySystemRPC(
host=self.config.get("api_host"),
api_key=self.config.get("api_key"),
)
self.hardware_interface = self.rpc_client
# 2. 启动连接监控
self.connection_monitor = ConnectionMonitor(self)
self.connection_monitor.start()
# 3. 启动 HTTP 回调服务
if hasattr(self, '_http_service_config'):
self.http_service = WorkstationHTTPService(
workstation_instance=self,
host=self._http_service_config["host"],
port=self._http_service_config["port"],
)
self.http_service.start()
# 4. 上传 deck 到云端
ROS2DeviceNode.run_async_func(
self._ros_node.update_resource, True,
**{"resources": [self.deck]}
)
# 5. 初始化资源同步器(可选)
self.resource_synchronizer = MyResourceSynchronizer(self, self.rpc_client)
```

View File

@@ -0,0 +1,233 @@
---
name: batch-insert-reagent
description: Batch insert reagents into Uni-Lab platform — add chemicals with CAS, SMILES, supplier info. Use when the user wants to add reagents, insert chemicals, batch register reagents, or mentions 录入试剂/添加试剂/试剂入库/reagent.
---
# 批量录入试剂 Skill
通过云端 API 批量录入试剂信息,支持逐条或批量操作。
## 前置条件(缺一不可)
使用本 skill 前,**必须**先确认以下信息。如果缺少任何一项,**立即向用户询问并终止**,等补齐后再继续。
### 1. ak / sk → AUTH
询问用户的启动参数,从 `--ak` `--sk` 或 config.py 中获取。
生成 AUTH token任选一种方式
```bash
# 方式一Python 一行生成
python -c "import base64,sys; print('Authorization: Lab ' + base64.b64encode(f'{sys.argv[1]}:{sys.argv[2]}'.encode()).decode())" <ak> <sk>
# 方式二:手动计算
# base64(ak:sk) → Authorization: Lab <token>
```
### 2. --addr → BASE URL
| `--addr` 值 | BASE |
|-------------|------|
| `test` | `https://uni-lab.test.bohrium.com` |
| `uat` | `https://uni-lab.uat.bohrium.com` |
| `local` | `http://127.0.0.1:48197` |
| 不传(默认) | `https://uni-lab.bohrium.com` |
确认后设置:
```bash
BASE="<根据 addr 确定的 URL>"
AUTH="Authorization: Lab <gen_auth.py 输出的 token>"
```
**两项全部就绪后才可发起 API 请求。**
## Session State
- `lab_uuid` — 实验室 UUID首次通过 API #1 自动获取,**不需要问用户**
## 请求约定
所有请求使用 `curl -s`POST 需加 `Content-Type: application/json`
> **Windows 平台**必须使用 `curl.exe`(而非 PowerShell 的 `curl` 别名),示例中的 `curl` 均指 `curl.exe`。
---
## API Endpoints
### 1. 获取实验室信息(自动获取 lab_uuid
```bash
curl -s -X GET "$BASE/api/v1/edge/lab/info" -H "$AUTH"
```
返回:
```json
{"code": 0, "data": {"uuid": "xxx", "name": "实验室名称"}}
```
记住 `data.uuid``lab_uuid`
### 2. 录入试剂
```bash
curl -s -X POST "$BASE/api/v1/lab/reagent" \
-H "$AUTH" -H "Content-Type: application/json" \
-d '{
"lab_uuid": "<lab_uuid>",
"cas": "<CAS号>",
"name": "<试剂名称>",
"molecular_formula": "<分子式>",
"smiles": "<SMILES>",
"stock_in_quantity": <入库数量>,
"unit": "<单位字符串>",
"supplier": "<供应商>",
"production_date": "<生产日期 ISO 8601>",
"expiry_date": "<过期日期 ISO 8601>"
}'
```
返回成功时包含试剂 UUID
```json
{"code": 0, "data": {"uuid": "xxx", ...}}
```
---
## 试剂字段说明
| 字段 | 类型 | 必填 | 说明 | 示例 |
|------|------|------|------|------|
| `lab_uuid` | string | 是 | 实验室 UUID从 API #1 获取) | `"8511c672-..."` |
| `cas` | string | 是 | CAS 注册号 | `"7732-18-3"` |
| `name` | string | 是 | 试剂中文/英文名称 | `"水"` |
| `molecular_formula` | string | 是 | 分子式 | `"H2O"` |
| `smiles` | string | 是 | SMILES 表示 | `"O"` |
| `stock_in_quantity` | number | 是 | 入库数量 | `10` |
| `unit` | string | 是 | 单位(字符串,见下表) | `"mL"` |
| `supplier` | string | 否 | 供应商名称 | `"国药集团"` |
| `production_date` | string | 否 | 生产日期ISO 8601 | `"2025-11-18T00:00:00Z"` |
| `expiry_date` | string | 否 | 过期日期ISO 8601 | `"2026-11-18T00:00:00Z"` |
### unit 单位值
| 值 | 单位 |
|------|------|
| `"mL"` | 毫升 |
| `"L"` | 升 |
| `"g"` | 克 |
| `"kg"` | 千克 |
| `"瓶"` | 瓶 |
> 根据试剂状态选择:液体用 `"mL"` / `"L"`,固体用 `"g"` / `"kg"`。
---
## 批量录入策略
### 方式一:用户提供 JSON 数组
用户一次性给出多条试剂数据:
```json
[
{"cas": "7732-18-3", "name": "水", "molecular_formula": "H2O", "smiles": "O", "stock_in_quantity": 10, "unit": "mL"},
{"cas": "64-17-5", "name": "乙醇", "molecular_formula": "C2H6O", "smiles": "CCO", "stock_in_quantity": 5, "unit": "L"}
]
```
Agent 自动为每条补充 `lab_uuid``production_date``expiry_date` 等字段后逐条提交。
Agent 循环调用 API #2 逐条录入,每条记录一次 API 调用。
### 方式二:用户逐个描述
用户口头描述试剂(如「帮我录入 500mL 的无水乙醇Sigma 的」agent 自行补全字段:
1. 根据名称查找 CAS 号、分子式、SMILES参考下方速查表或自行推断
2. 构建完整的请求体
3. 向用户确认后提交
### 方式三:从 CSV/表格批量导入
用户提供 CSV 或表格文件路径agent 读取并解析:
```bash
# 期望的 CSV 格式(首行为表头)
cas,name,molecular_formula,smiles,stock_in_quantity,unit,supplier,production_date,expiry_date
7732-18-3,水,H2O,O,10,mL,农夫山泉,2025-11-18T00:00:00Z,2026-11-18T00:00:00Z
```
### 执行与汇报
每次 API 调用后:
1. 检查返回 `code`0 = 成功)
2. 记录成功/失败数量
3. 全部完成后汇总:「共录入 N 条试剂,成功 X 条,失败 Y 条」
4. 如有失败,列出失败的试剂名称和错误信息
---
## 常见试剂速查表
| 名称 | CAS | 分子式 | SMILES |
|------|-----|--------|--------|
| 水 | 7732-18-3 | H2O | O |
| 乙醇 | 64-17-5 | C2H6O | CCO |
| 甲醇 | 67-56-1 | CH4O | CO |
| 丙酮 | 67-64-1 | C3H6O | CC(C)=O |
| 二甲基亚砜(DMSO) | 67-68-5 | C2H6OS | CS(C)=O |
| 乙酸乙酯 | 141-78-6 | C4H8O2 | CCOC(C)=O |
| 二氯甲烷 | 75-09-2 | CH2Cl2 | ClCCl |
| 四氢呋喃(THF) | 109-99-9 | C4H8O | C1CCOC1 |
| N,N-二甲基甲酰胺(DMF) | 68-12-2 | C3H7NO | CN(C)C=O |
| 氯仿 | 67-66-3 | CHCl3 | ClC(Cl)Cl |
| 乙腈 | 75-05-8 | C2H3N | CC#N |
| 甲苯 | 108-88-3 | C7H8 | Cc1ccccc1 |
| 正己烷 | 110-54-3 | C6H14 | CCCCCC |
| 异丙醇 | 67-63-0 | C3H8O | CC(C)O |
| 盐酸 | 7647-01-0 | HCl | Cl |
| 硫酸 | 7664-93-9 | H2SO4 | OS(O)(=O)=O |
| 氢氧化钠 | 1310-73-2 | NaOH | [Na]O |
| 碳酸钠 | 497-19-8 | Na2CO3 | [Na]OC([O-])=O.[Na+] |
| 氯化钠 | 7647-14-5 | NaCl | [Na]Cl |
| 乙二胺四乙酸(EDTA) | 60-00-4 | C10H16N2O8 | OC(=O)CN(CCN(CC(O)=O)CC(O)=O)CC(O)=O |
> 此表仅供快速参考。对于不在表中的试剂agent 应根据化学知识推断或提示用户补充。
---
## 完整工作流 Checklist
```
Task Progress:
- [ ] Step 1: 确认 ak/sk → 生成 AUTH token
- [ ] Step 2: 确认 --addr → 设置 BASE URL
- [ ] Step 3: GET /edge/lab/info → 获取 lab_uuid
- [ ] Step 4: 收集试剂信息(用户提供列表/逐个描述/CSV文件
- [ ] Step 5: 补全缺失字段CAS、分子式、SMILES 等)
- [ ] Step 6: 向用户确认待录入的试剂列表
- [ ] Step 7: 循环调用 POST /lab/reagent 逐条录入(每条需含 lab_uuid
- [ ] Step 8: 汇总结果(成功/失败数量及详情)
```
---
## 完整示例
用户说:「帮我录入 3 种试剂500mL 无水乙醇、1kg 氯化钠、2L 去离子水」
Agent 构建的请求序列:
```json
// 第 1 条
{"lab_uuid": "8511c672-...", "cas": "64-17-5", "name": "无水乙醇", "molecular_formula": "C2H6O", "smiles": "CCO", "stock_in_quantity": 500, "unit": "mL", "supplier": "国药集团", "production_date": "2025-01-01T00:00:00Z", "expiry_date": "2026-01-01T00:00:00Z"}
// 第 2 条
{"lab_uuid": "8511c672-...", "cas": "7647-14-5", "name": "氯化钠", "molecular_formula": "NaCl", "smiles": "[Na]Cl", "stock_in_quantity": 1, "unit": "kg", "supplier": "", "production_date": "2025-01-01T00:00:00Z", "expiry_date": "2026-01-01T00:00:00Z"}
// 第 3 条
{"lab_uuid": "8511c672-...", "cas": "7732-18-3", "name": "去离子水", "molecular_formula": "H2O", "smiles": "O", "stock_in_quantity": 2, "unit": "L", "supplier": "", "production_date": "2025-01-01T00:00:00Z", "expiry_date": "2026-01-01T00:00:00Z"}
```

View File

@@ -0,0 +1,325 @@
---
name: batch-submit-experiment
description: Batch submit experiments (notebooks) to Uni-Lab platform — list workflows, generate node_params from registry schemas, submit multiple rounds, check notebook status. Use when the user wants to submit experiments, create notebooks, batch run workflows, check experiment status, or mentions 提交实验/批量实验/notebook/实验轮次/实验状态.
---
# 批量提交实验指南
通过云端 API 批量提交实验notebook支持多轮实验参数配置。根据 workflow 模板详情和本地设备注册表自动生成 `node_params` 模板。
## 前置条件(缺一不可)
使用本指南前,**必须**先确认以下信息。如果缺少任何一项,**立即向用户询问并终止**,等补齐后再继续。
### 1. ak / sk → AUTH
询问用户的启动参数,从 `--ak` `--sk` 或 config.py 中获取。
生成 AUTH token任选一种方式
```bash
# 方式一Python 一行生成
python -c "import base64,sys; print('Authorization: Lab ' + base64.b64encode(f'{sys.argv[1]}:{sys.argv[2]}'.encode()).decode())" <ak> <sk>
# 方式二:手动计算
# base64(ak:sk) → Authorization: Lab <token>
```
### 2. --addr → BASE URL
| `--addr` 值 | BASE |
|-------------|------|
| `test` | `https://uni-lab.test.bohrium.com` |
| `uat` | `https://uni-lab.uat.bohrium.com` |
| `local` | `http://127.0.0.1:48197` |
| 不传(默认) | `https://uni-lab.bohrium.com` |
确认后设置:
```bash
BASE="<根据 addr 确定的 URL>"
AUTH="Authorization: Lab <上面命令输出的 token>"
```
### 3. req_device_registry_upload.json设备注册表
**批量提交实验时需要本地注册表来解析 workflow 节点的参数 schema。**
按优先级搜索:
```
<workspace 根目录>/unilabos_data/req_device_registry_upload.json
<workspace 根目录>/req_device_registry_upload.json
```
也可直接 Glob 搜索:`**/req_device_registry_upload.json`
找到后**检查文件修改时间**并告知用户。超过 1 天提醒用户是否需要重新启动 `unilab`
**如果文件不存在** → 告知用户先运行 `unilab` 启动命令,等注册表生成后再执行。可跳过此步,但将无法自动生成参数模板,需要用户手动填写 `param`
### 4. workflow_uuid目标工作流
用户需要提供要提交的 workflow UUID。如果用户不确定通过 API #3 列出可用 workflow 供选择。
**四项全部就绪后才可开始。**
## Session State
在整个对话过程中agent 需要记住以下状态,避免重复询问用户:
- `lab_uuid` — 实验室 UUID首次通过 API #1 自动获取,**不需要问用户**
- `project_uuid` — 项目 UUID通过 API #2 列出项目列表,**让用户选择**
- `workflow_uuid` — 工作流 UUID用户提供或从列表选择
- `workflow_nodes` — workflow 中各 action 节点的 uuid、设备 ID、动作名从 API #4 获取)
## 请求约定
所有请求使用 `curl -s`POST 需加 `Content-Type: application/json`
> **Windows 平台**必须使用 `curl.exe`(而非 PowerShell 的 `curl` 别名),示例中的 `curl` 均指 `curl.exe`。
>
> **PowerShell JSON 传参**PowerShell 中 `-d '{"key":"value"}'` 会因引号转义失败。请将 JSON 写入临时文件,用 `-d '@tmp_body.json'`(单引号包裹 `@`,否则会被解析为 splatting 运算符)。
---
## API Endpoints
### 1. 获取实验室信息(自动获取 lab_uuid
```bash
curl -s -X GET "$BASE/api/v1/edge/lab/info" -H "$AUTH"
```
返回:
```json
{"code": 0, "data": {"uuid": "xxx", "name": "实验室名称"}}
```
记住 `data.uuid``lab_uuid`
### 2. 列出实验室项目(让用户选择项目)
```bash
curl -s -X GET "$BASE/api/v1/lab/project/list?lab_uuid=$lab_uuid" -H "$AUTH"
```
返回项目列表,展示给用户选择。列出每个项目的 `uuid``name`
用户**必须**选择一个项目,记住 `project_uuid`,后续创建 notebook 时需要提供。
### 3. 列出可用 workflow
```bash
curl -s -X GET "$BASE/api/v1/lab/workflow/workflows?page=1&page_size=20&lab_uuid=$lab_uuid" -H "$AUTH"
```
返回 workflow 列表,展示给用户选择。列出每个 workflow 的 `uuid``name`
### 4. 获取 workflow 模板详情
```bash
curl -s -X GET "$BASE/api/v1/lab/workflow/template/detail/$workflow_uuid" -H "$AUTH"
```
返回 workflow 的完整结构,包含所有 action 节点信息。需要从响应中提取:
- 每个 action 节点的 `node_uuid`
- 每个节点对应的设备 ID`resource_template_name`
- 每个节点的动作名(`node_template_name`
- 每个节点的现有参数(`param`
> **注意**:此 API 返回格式可能因版本不同而有差异。首次调用时,先打印完整响应分析结构,再提取节点信息。常见的节点字段路径为 `data.nodes[]` 或 `data.workflow_nodes[]`。
### 5. 提交实验(创建 notebook
```bash
curl -s -X POST "$BASE/api/v1/lab/notebook" \
-H "$AUTH" -H "Content-Type: application/json" \
-d '<request_body>'
```
请求体结构:
```json
{
"lab_uuid": "<lab_uuid>",
"project_uuid": "<project_uuid>",
"workflow_uuid": "<workflow_uuid>",
"name": "<实验名称>",
"node_params": [
{
"sample_uuids": ["<样品UUID1>", "<样品UUID2>"],
"datas": [
{
"node_uuid": "<workflow中的节点UUID>",
"param": {},
"sample_params": [
{
"container_uuid": "<容器UUID>",
"sample_value": {
"liquid_names": "<液体名称>",
"volumes": 1000
}
}
]
}
]
}
]
}
```
> **注意**`sample_uuids` 必须是 **UUID 数组**`[]uuid.UUID`),不是字符串。无样品时传空数组 `[]`。
### 6. 查询 notebook 状态
提交成功后,使用返回的 notebook UUID 查询执行状态:
```bash
curl -s -X GET "$BASE/api/v1/lab/notebook/status?uuid=$notebook_uuid" -H "$AUTH"
```
提交后应**立即查询一次**状态,确认 notebook 已被正确接收并开始调度。
---
## Notebook 请求体详解
### node_params 结构
`node_params` 是一个数组,**每个元素代表一轮实验**
- 要跑 2 轮 → `node_params` 有 2 个元素
- 要跑 N 轮 → `node_params` 有 N 个元素
### 每轮的字段
| 字段 | 类型 | 说明 |
|------|------|------|
| `sample_uuids` | array\<uuid\> | 该轮实验的样品 UUID 数组,无样品时传 `[]` |
| `datas` | array | 该轮中每个 workflow 节点的参数配置 |
### datas 中每个节点
| 字段 | 类型 | 说明 |
|------|------|------|
| `node_uuid` | string | workflow 模板中的节点 UUID从 API #4 获取) |
| `param` | object | 动作参数(根据本地注册表 schema 填写) |
| `sample_params` | array | 样品相关参数(液体名、体积等) |
### sample_params 中每条
| 字段 | 类型 | 说明 |
|------|------|------|
| `container_uuid` | string | 容器 UUID |
| `sample_value` | object | 样品值,如 `{"liquid_names": "水", "volumes": 1000}` |
---
## 从本地注册表生成 param 模板
### 自动方式 — 运行脚本
```bash
python scripts/gen_notebook_params.py \
--auth <token> \
--base <BASE_URL> \
--workflow-uuid <workflow_uuid> \
[--registry <path/to/req_device_registry_upload.json>] \
[--rounds <轮次数>] \
[--output <输出文件路径>]
```
> 脚本位于本文档同级目录下的 `scripts/gen_notebook_params.py`。
脚本会:
1. 调用 workflow detail API 获取所有 action 节点
2. 读取本地注册表,为每个节点查找对应的 action schema
3. 生成 `notebook_template.json`,包含:
- 完整 `node_params` 骨架
- 每个节点的 param 字段及类型说明
- `_schema_info` 辅助信息(不提交,仅供参考)
### 手动方式
如果脚本不可用或注册表不存在:
1. 调用 API #4 获取 workflow 详情
2. 找到每个 action 节点的 `node_uuid`
3. 在本地注册表中查找对应设备的 `action_value_mappings`
```
resources[].id == <device_id>
→ resources[].class.action_value_mappings.<action_name>.schema.properties.goal.properties
```
4. 将 schema 中的 properties 作为 `param` 的字段模板
5. 按轮次复制 `node_params` 元素,让用户填写每轮的具体值
### 注册表结构参考
```json
{
"resources": [
{
"id": "liquid_handler.prcxi",
"class": {
"module": "unilabos.devices.xxx:ClassName",
"action_value_mappings": {
"transfer_liquid": {
"type": "LiquidHandlerTransfer",
"schema": {
"properties": {
"goal": {
"properties": {
"asp_vols": {"type": "array", "items": {"type": "number"}},
"sources": {"type": "array"}
},
"required": ["asp_vols", "sources"]
}
}
},
"goal_default": {}
}
}
}
}
]
}
```
`param` 填写时,使用 `goal.properties` 中的字段名和类型。
---
## 完整工作流 Checklist
```
Task Progress:
- [ ] Step 1: 确认 ak/sk → 生成 AUTH token
- [ ] Step 2: 确认 --addr → 设置 BASE URL
- [ ] Step 3: GET /edge/lab/info → 获取 lab_uuid
- [ ] Step 4: GET /lab/project/list → 列出项目,让用户选择 → 获取 project_uuid
- [ ] Step 5: 确认 workflow_uuid用户提供或从 GET #3 列表选择)
- [ ] Step 6: GET workflow detail (#4) → 提取各节点 uuid、设备ID、动作名
- [ ] Step 7: 定位本地注册表 req_device_registry_upload.json
- [ ] Step 8: 运行 gen_notebook_params.py 或手动匹配 → 生成 node_params 模板
- [ ] Step 9: 引导用户填写每轮的参数sample_uuids、param、sample_params
- [ ] Step 10: 构建完整请求体(含 project_uuid→ POST /lab/notebook 提交
- [ ] Step 11: 检查返回结果,记录 notebook UUID
- [ ] Step 12: GET /lab/notebook/status → 查询 notebook 状态,确认已调度
```
---
## 常见问题
### Q: workflow 中有多个节点,每轮都要填所有节点的参数吗?
是的。`datas` 数组中需要包含该轮实验涉及的每个 workflow 节点的参数。通常每个 action 节点都需要一条 `datas` 记录。
### Q: 多轮实验的参数完全不同吗?
通常每轮的 `param`(设备动作参数)可能相同或相似,但 `sample_uuids` 和 `sample_params`(样品信息)每轮不同。脚本生成模板时会按轮次复制骨架,用户只需修改差异部分。
### Q: 如何获取 sample_uuids 和 container_uuid
这些 UUID 通常来自实验室的样品管理系统。向用户询问或从资源树API `GET /lab/material/download/$lab_uuid`)中查找。

View File

@@ -0,0 +1,395 @@
#!/usr/bin/env python3
"""
从 workflow 模板详情 + 本地设备注册表生成 notebook 提交用的 node_params 模板。
用法:
python gen_notebook_params.py --auth <token> --base <url> --workflow-uuid <uuid> [选项]
选项:
--auth <token> Lab tokenbase64(ak:sk) 的结果,不含 "Lab " 前缀)
--base <url> API 基础 URL如 https://uni-lab.test.bohrium.com
--workflow-uuid <uuid> 目标 workflow 的 UUID
--registry <path> 本地注册表文件路径(默认自动搜索)
--rounds <n> 实验轮次数(默认 1
--output <path> 输出模板文件路径(默认 notebook_template.json
--dump-response 打印 workflow detail API 的原始响应(调试用)
示例:
python gen_notebook_params.py \\
--auth YTFmZDlkNGUtxxxx \\
--base https://uni-lab.test.bohrium.com \\
--workflow-uuid abc-123-def \\
--rounds 2
"""
import copy
import json
import os
import sys
from datetime import datetime
from urllib.request import Request, urlopen
from urllib.error import HTTPError, URLError
REGISTRY_FILENAME = "req_device_registry_upload.json"
def find_registry(explicit_path=None):
"""查找本地注册表文件,逻辑同 extract_device_actions.py"""
if explicit_path:
if os.path.isfile(explicit_path):
return explicit_path
if os.path.isdir(explicit_path):
fp = os.path.join(explicit_path, REGISTRY_FILENAME)
if os.path.isfile(fp):
return fp
print(f"警告: 指定的注册表路径不存在: {explicit_path}")
return None
candidates = [
os.path.join("unilabos_data", REGISTRY_FILENAME),
REGISTRY_FILENAME,
]
for c in candidates:
if os.path.isfile(c):
return c
script_dir = os.path.dirname(os.path.abspath(__file__))
workspace_root = os.path.normpath(os.path.join(script_dir, "..", "..", ".."))
for c in candidates:
path = os.path.join(workspace_root, c)
if os.path.isfile(path):
return path
cwd = os.getcwd()
for _ in range(5):
parent = os.path.dirname(cwd)
if parent == cwd:
break
cwd = parent
for c in candidates:
path = os.path.join(cwd, c)
if os.path.isfile(path):
return path
return None
def load_registry(path):
with open(path, "r", encoding="utf-8") as f:
return json.load(f)
def build_registry_index(registry_data):
"""构建 device_id → action_value_mappings 的索引"""
index = {}
for res in registry_data.get("resources", []):
rid = res.get("id", "")
avm = res.get("class", {}).get("action_value_mappings", {})
if rid and avm:
index[rid] = avm
return index
def flatten_goal_schema(action_data):
"""从 action_value_mappings 条目中提取 goal 层的 schema"""
schema = action_data.get("schema", {})
goal_schema = schema.get("properties", {}).get("goal", {})
return goal_schema if goal_schema else schema
def build_param_template(goal_schema):
"""根据 goal schema 生成 param 模板,含类型标注"""
properties = goal_schema.get("properties", {})
required = set(goal_schema.get("required", []))
template = {}
for field_name, field_def in properties.items():
if field_name == "unilabos_device_id":
continue
ftype = field_def.get("type", "any")
default = field_def.get("default")
if default is not None:
template[field_name] = default
elif ftype == "string":
template[field_name] = f"$TODO ({ftype}, {'required' if field_name in required else 'optional'})"
elif ftype == "number" or ftype == "integer":
template[field_name] = 0
elif ftype == "boolean":
template[field_name] = False
elif ftype == "array":
template[field_name] = []
elif ftype == "object":
template[field_name] = {}
else:
template[field_name] = f"$TODO ({ftype})"
return template
def fetch_workflow_detail(base_url, auth_token, workflow_uuid):
"""调用 workflow detail API"""
url = f"{base_url}/api/v1/lab/workflow/template/detail/{workflow_uuid}"
req = Request(url, method="GET")
req.add_header("Authorization", f"Lab {auth_token}")
try:
with urlopen(req, timeout=30) as resp:
return json.loads(resp.read().decode("utf-8"))
except HTTPError as e:
body = e.read().decode("utf-8", errors="replace")
print(f"API 错误 {e.code}: {body}")
return None
except URLError as e:
print(f"网络错误: {e.reason}")
return None
def extract_nodes_from_response(response):
"""
从 workflow detail 响应中提取 action 节点列表。
适配多种可能的响应格式。
返回: [(node_uuid, resource_template_name, node_template_name, existing_param), ...]
"""
data = response.get("data", response)
search_keys = ["nodes", "workflow_nodes", "node_list", "steps"]
nodes_raw = None
for key in search_keys:
if key in data and isinstance(data[key], list):
nodes_raw = data[key]
break
if nodes_raw is None:
if isinstance(data, list):
nodes_raw = data
else:
for v in data.values():
if isinstance(v, list) and len(v) > 0 and isinstance(v[0], dict):
nodes_raw = v
break
if not nodes_raw:
print("警告: 未能从响应中提取节点列表")
print("响应顶层 keys:", list(data.keys()) if isinstance(data, dict) else type(data).__name__)
return []
result = []
for node in nodes_raw:
if not isinstance(node, dict):
continue
node_uuid = (
node.get("uuid")
or node.get("node_uuid")
or node.get("id")
or ""
)
resource_name = (
node.get("resource_template_name")
or node.get("device_id")
or node.get("resource_name")
or node.get("device_name")
or ""
)
template_name = (
node.get("node_template_name")
or node.get("action_name")
or node.get("template_name")
or node.get("action")
or node.get("name")
or ""
)
existing_param = node.get("param", {}) or {}
if node_uuid:
result.append((node_uuid, resource_name, template_name, existing_param))
return result
def generate_template(nodes, registry_index, rounds):
"""生成 notebook 提交模板"""
node_params = []
schema_info = {}
datas_template = []
for node_uuid, resource_name, template_name, existing_param in nodes:
param_template = {}
matched = False
if resource_name and template_name and resource_name in registry_index:
avm = registry_index[resource_name]
if template_name in avm:
goal_schema = flatten_goal_schema(avm[template_name])
param_template = build_param_template(goal_schema)
goal_default = avm[template_name].get("goal_default", {})
if goal_default:
for k, v in goal_default.items():
if k in param_template and v is not None:
param_template[k] = v
matched = True
schema_info[node_uuid] = {
"device_id": resource_name,
"action_name": template_name,
"action_type": avm[template_name].get("type", ""),
"schema_properties": list(goal_schema.get("properties", {}).keys()),
"required": goal_schema.get("required", []),
}
if not matched and existing_param:
param_template = existing_param
if not matched and not existing_param:
schema_info[node_uuid] = {
"device_id": resource_name,
"action_name": template_name,
"warning": "未在本地注册表中找到匹配的 action schema",
}
datas_template.append({
"node_uuid": node_uuid,
"param": param_template,
"sample_params": [
{
"container_uuid": "$TODO_CONTAINER_UUID",
"sample_value": {
"liquid_names": "$TODO_LIQUID_NAME",
"volumes": 0,
},
}
],
})
for i in range(rounds):
node_params.append({
"sample_uuids": f"$TODO_SAMPLE_UUID_ROUND_{i + 1}",
"datas": copy.deepcopy(datas_template),
})
return {
"lab_uuid": "$TODO_LAB_UUID",
"project_uuid": "$TODO_PROJECT_UUID",
"workflow_uuid": "$TODO_WORKFLOW_UUID",
"name": "$TODO_EXPERIMENT_NAME",
"node_params": node_params,
"_schema_info仅参考提交时删除": schema_info,
}
def parse_args(argv):
"""简单的参数解析"""
opts = {
"auth": None,
"base": None,
"workflow_uuid": None,
"registry": None,
"rounds": 1,
"output": "notebook_template.json",
"dump_response": False,
}
i = 0
while i < len(argv):
arg = argv[i]
if arg == "--auth" and i + 1 < len(argv):
opts["auth"] = argv[i + 1]
i += 2
elif arg == "--base" and i + 1 < len(argv):
opts["base"] = argv[i + 1].rstrip("/")
i += 2
elif arg == "--workflow-uuid" and i + 1 < len(argv):
opts["workflow_uuid"] = argv[i + 1]
i += 2
elif arg == "--registry" and i + 1 < len(argv):
opts["registry"] = argv[i + 1]
i += 2
elif arg == "--rounds" and i + 1 < len(argv):
opts["rounds"] = int(argv[i + 1])
i += 2
elif arg == "--output" and i + 1 < len(argv):
opts["output"] = argv[i + 1]
i += 2
elif arg == "--dump-response":
opts["dump_response"] = True
i += 1
else:
print(f"未知参数: {arg}")
i += 1
return opts
def main():
opts = parse_args(sys.argv[1:])
if not opts["auth"] or not opts["base"] or not opts["workflow_uuid"]:
print("用法:")
print(" python gen_notebook_params.py --auth <token> --base <url> --workflow-uuid <uuid> [选项]")
print()
print("必需参数:")
print(" --auth <token> Lab tokenbase64(ak:sk)")
print(" --base <url> API 基础 URL")
print(" --workflow-uuid <uuid> 目标 workflow UUID")
print()
print("可选参数:")
print(" --registry <path> 注册表文件路径(默认自动搜索)")
print(" --rounds <n> 实验轮次数(默认 1")
print(" --output <path> 输出文件路径(默认 notebook_template.json")
print(" --dump-response 打印 API 原始响应")
sys.exit(1)
# 1. 查找并加载本地注册表
registry_path = find_registry(opts["registry"])
registry_index = {}
if registry_path:
mtime = os.path.getmtime(registry_path)
gen_time = datetime.fromtimestamp(mtime).strftime("%Y-%m-%d %H:%M:%S")
print(f"注册表: {registry_path} (生成时间: {gen_time})")
registry_data = load_registry(registry_path)
registry_index = build_registry_index(registry_data)
print(f"已索引 {len(registry_index)} 个设备的 action schemas")
else:
print("警告: 未找到本地注册表,将跳过 param 模板生成")
print(" 提交时需要手动填写各节点的 param 字段")
# 2. 获取 workflow 详情
print(f"\n正在获取 workflow 详情: {opts['workflow_uuid']}")
response = fetch_workflow_detail(opts["base"], opts["auth"], opts["workflow_uuid"])
if not response:
print("错误: 无法获取 workflow 详情")
sys.exit(1)
if opts["dump_response"]:
print("\n=== API 原始响应 ===")
print(json.dumps(response, indent=2, ensure_ascii=False)[:5000])
print("=== 响应结束(截断至 5000 字符) ===\n")
# 3. 提取节点
nodes = extract_nodes_from_response(response)
if not nodes:
print("错误: 未能从 workflow 中提取任何 action 节点")
print("请使用 --dump-response 查看原始响应结构")
sys.exit(1)
print(f"\n找到 {len(nodes)} 个 action 节点:")
print(f" {'节点 UUID':<40} {'设备 ID':<30} {'动作名':<25} {'Schema'}")
print(" " + "-" * 110)
for node_uuid, resource_name, template_name, _ in nodes:
matched = "" if (resource_name in registry_index and
template_name in registry_index.get(resource_name, {})) else ""
print(f" {node_uuid:<40} {resource_name:<30} {template_name:<25} {matched}")
# 4. 生成模板
template = generate_template(nodes, registry_index, opts["rounds"])
template["workflow_uuid"] = opts["workflow_uuid"]
output_path = opts["output"]
with open(output_path, "w", encoding="utf-8") as f:
json.dump(template, f, indent=2, ensure_ascii=False)
print(f"\n模板已写入: {output_path}")
print(f" 轮次数: {opts['rounds']}")
print(f" 节点数/轮: {len(nodes)}")
print()
print("下一步:")
print(" 1. 打开模板文件,将 $TODO 占位符替换为实际值")
print(" 2. 删除 _schema_info 字段(仅供参考)")
print(" 3. 使用 POST /api/v1/lab/notebook 提交")
if __name__ == "__main__":
main()

View File

@@ -0,0 +1,380 @@
---
name: create-device-skill
description: Create a skill for any Uni-Lab device by extracting action schemas from the device registry. Use when the user wants to create a new device skill, add device API documentation, or set up action schemas for a device.
---
# 创建设备 Skill 指南
本 meta-skill 教你如何为任意 Uni-Lab-OS 设备创建完整的 API 操作技能(参考 `unilab-device-api` 的成功案例)。
## 数据源
- **设备注册表**: `unilabos_data/req_device_registry_upload.json`
- **结构**: `{ "resources": [{ "id": "<device_id>", "class": { "module": "<python_module:ClassName>", "action_value_mappings": { ... } } }] }`
- **生成时机**: `unilab` 启动并完成注册表上传后自动生成
- **module 字段**: 格式 `unilabos.devices.xxx.yyy:ClassName`,可转为源码路径 `unilabos/devices/xxx/yyy.py`,阅读源码可了解参数含义和设备行为
## 创建流程
### Step 0 — 收集必备信息(缺一不可,否则询问后终止)
开始前**必须**确认以下 4 项信息全部就绪。如果用户未提供任何一项,**立即询问并终止当前流程**,等用户补齐后再继续。
向用户提问:「请提供你的 unilab 启动参数,我需要以下信息:」
#### 必备项 ①ak / sk认证凭据
来源:启动命令的 `--ak` `--sk` 参数,或 config.py 中的 `ak = "..."` `sk = "..."`
获取后立即生成 AUTH token
```bash
python ./scripts/gen_auth.py <ak> <sk>
# 或从 config.py 提取
python ./scripts/gen_auth.py --config <config.py>
```
认证算法:`base64(ak:sk)``Authorization: Lab <token>`
#### 必备项 ②:--addr目标环境
决定 API 请求发往哪个服务器。从启动命令的 `--addr` 参数获取:
| `--addr` 值 | BASE URL |
|-------------|----------|
| `test` | `https://uni-lab.test.bohrium.com` |
| `uat` | `https://uni-lab.uat.bohrium.com` |
| `local` | `http://127.0.0.1:48197` |
| 不传(默认) | `https://uni-lab.bohrium.com` |
| 其他自定义 URL | 直接使用该 URL |
#### 必备项 ③req_device_registry_upload.json设备注册表
数据文件由 `unilab` 启动时自动生成,需要定位它:
**推断 working_dir**(即 `unilabos_data` 所在目录):
| 条件 | working_dir 取值 |
|------|------------------|
| 传了 `--working_dir` | `<working_dir>/unilabos_data/`(若子目录已存在则直接用) |
| 仅传了 `--config` | `<config 文件所在目录>/unilabos_data/` |
| 都没传 | `<当前工作目录>/unilabos_data/` |
**按优先级搜索文件**
```
<推断的 working_dir>/unilabos_data/req_device_registry_upload.json
<推断的 working_dir>/req_device_registry_upload.json
<workspace 根目录>/unilabos_data/req_device_registry_upload.json
```
也可以直接 Glob 搜索:`**/req_device_registry_upload.json`
找到后**必须检查文件修改时间**并告知用户:「找到注册表文件 `<路径>`,生成于 `<时间>`。请确认这是最近一次启动生成的。」超过 1 天提醒用户是否需要重新启动 `unilab`
**如果文件不存在** → 告知用户先运行 `unilab` 启动命令,等日志出现 `注册表响应数据已保存` 后再执行本流程。**终止。**
#### 必备项 ④:目标设备
用户需要明确要为哪个设备创建 skill。可以是设备名称如「PRCXI 移液站」)或 device_id`liquid_handler.prcxi`)。
如果用户不确定,运行提取脚本列出所有设备供选择:
```bash
python ./scripts/extract_device_actions.py --registry <找到的文件路径>
```
#### 完整示例
用户提供:
```
--ak a1fd9d4e-xxxx-xxxx-xxxx-d9a69c09f0fd
--sk 136ff5c6-xxxx-xxxx-xxxx-a03e301f827b
--addr test
--port 8003
--disable_browser
```
从中提取:
- ✅ ak/sk → 运行 `gen_auth.py` 得到 `AUTH="Authorization: Lab YTFmZDlk..."`
- ✅ addr=test → `BASE=https://uni-lab.test.bohrium.com`
- ✅ 搜索 `unilabos_data/req_device_registry_upload.json` → 找到并确认时间
- ✅ 用户指明目标设备 → 如 `liquid_handler.prcxi`
**四项全部就绪后才进入 Step 1。**
### Step 1 — 列出可用设备
运行提取脚本,列出所有设备及 action 数量和 Python 源码路径,让用户选择:
```bash
# 自动搜索(默认在 unilabos_data/ 和当前目录查找)
python ./scripts/extract_device_actions.py
# 指定注册表文件路径
python ./scripts/extract_device_actions.py --registry <path/to/req_device_registry_upload.json>
```
脚本输出包含每个设备的 **Python 源码路径**(从 `class.module` 转换),可用于后续阅读源码理解参数含义。
### Step 2 — 提取 Action Schema
用户选择设备后,运行提取脚本:
```bash
python ./scripts/extract_device_actions.py [--registry <path>] <device_id> ./skills/<skill-name>/actions/
```
脚本会显示设备的 Python 源码路径和类名,方便阅读源码了解参数含义。
每个 action 生成一个 JSON 文件,包含:
- `type` — 作为 API 调用的 `action_type`
- `schema` — 完整 JSON Schema`properties.goal.properties` 参数定义)
- `goal` — goal 字段映射(含占位符 `$placeholder`
- `goal_default` — 默认值
### Step 3 — 写 action-index.md
按模板为每个 action 写条目:
```markdown
### `<action_name>`
<用途描述(一句话)>
- **Schema**: [`actions/<filename>.json`](actions/<filename>.json)
- **核心参数**: `param1`, `param2`(从 schema.required 获取)
- **可选参数**: `param3`, `param4`
- **占位符字段**: `field`(需填入物料信息,值以 `$` 开头)
```
描述规则:
-`schema.properties` 读参数列表schema 已提升为 goal 内容)
-`schema.required` 区分核心/可选参数
- 按功能分类(移液、枪头、外设等)
- 标注 `placeholder_keys` 中的字段类型:
- `unilabos_resources`**ResourceSlot**,填入 `{id, name, uuid}`id 是路径格式,从资源树取物料节点)
- `unilabos_devices`**DeviceSlot**,填入路径字符串如 `"/host_node"`(从资源树筛选 type=device
- `unilabos_nodes`**NodeSlot**,填入路径字符串如 `"/PRCXI/PRCXI_Deck"`(资源树中任意节点)
- `unilabos_class`**ClassSlot**,填入类名字符串如 `"container"`(从注册表查找)
- `unilabos_formulation`**FormulationSlot**,填入配方数组 `[{well_name, liquids: [{name, volume}]}]`well_name 为目标物料的 name
- array 类型字段 → `[{id, name, uuid}, ...]`
- 特殊:`create_resource``res_id`ResourceSlot可填不存在的路径
### Step 4 — 写 SKILL.md
直接复用 `unilab-device-api` 的 API 模板,修改:
- 设备名称
- Action 数量
- 目录列表
- Session state 中的 `device_name`
- **AUTH 头** — 使用 Step 0 中 `gen_auth.py` 生成的 `Authorization: Lab <token>`(不要硬编码 `Api` 类型的 key
- **Python 源码路径** — 在 SKILL.md 开头注明设备对应的源码文件,方便参考参数含义
- **Slot 字段表** — 列出本设备哪些 action 的哪些字段需要填入 Slot物料/设备/节点/类名)
API 模板结构:
```markdown
## 设备信息
- device_id, Python 源码路径, 设备类名
## 前置条件(缺一不可)
- ak/sk → AUTH, --addr → BASE URL
## 请求约定
- Windows 平台必须用 curl.exe非 PowerShell 的 curl 别名)
## Session State
- lab_uuid通过 GET /edge/lab/info 直接获取,不要问用户), device_name
## API Endpoints
# - #1 GET /edge/lab/info → 直接拿到 lab_uuid
# - #2 创建工作流 POST /lab/workflow/owner → 拼 URL 告知用户
# - #3 创建节点 POST /edge/workflow/node
# body: {workflow_uuid, resource_template_name: "<device_id>", node_template_name: "<action_name>"}
# - #4 删除节点 DELETE /lab/workflow/nodes
# - #5 更新节点参数 PATCH /lab/workflow/node
# - #6 查询节点 handles POST /lab/workflow/node-handles
# body: {node_uuids: ["uuid1","uuid2"]} → 返回各节点的 handle_uuid
# - #7 批量创建边 POST /lab/workflow/edges
# body: {edges: [{source_node_uuid, target_node_uuid, source_handle_uuid, target_handle_uuid}]}
# - #8 启动工作流 POST /lab/workflow/{uuid}/run
# - #9 运行设备单动作 POST /lab/mcp/run/action
# - #10 查询任务状态 GET /lab/mcp/task/{task_uuid}
# - #11 运行工作流单节点 POST /lab/mcp/run/workflow/action
# - #12 获取资源树 GET /lab/material/download/{lab_uuid}
# - #13 获取工作流模板详情 GET /lab/workflow/template/detail/{workflow_uuid}
# 返回 workflow 完整结构data.nodes[] 含每个节点的 uuid、name、param、device_name、handles
## Placeholder Slot 填写规则
- unilabos_resources → ResourceSlot → {"id":"/path/name","name":"name","uuid":"xxx"}
- unilabos_devices → DeviceSlot → "/parent/device" 路径字符串
- unilabos_nodes → NodeSlot → "/parent/node" 路径字符串
- unilabos_class → ClassSlot → "class_name" 字符串
- unilabos_formulation → FormulationSlot → [{well_name, liquids: [{name, volume}]}] 配方数组
- 特例create_resource 的 res_id 允许填不存在的路径
- 列出本设备所有 Slot 字段、类型及含义
## 渐进加载策略
## 完整工作流 Checklist
```
### Step 5 — 验证
检查文件完整性:
- [ ] `SKILL.md` 包含 API endpoint#1 获取 lab_uuid、#2-#7 工作流/节点/边、#8-#11 运行/查询、#12 资源树、#13 工作流模板详情)
- [ ] `SKILL.md` 包含 Placeholder Slot 填写规则ResourceSlot / DeviceSlot / NodeSlot / ClassSlot / FormulationSlot + create_resource 特例)和本设备的 Slot 字段表
- [ ] `action-index.md` 列出所有 action 并有描述
- [ ] `actions/` 目录中每个 action 有对应 JSON 文件
- [ ] JSON 文件包含 `type`, `schema`(已提升为 goal 内容), `goal`, `goal_default`, `placeholder_keys` 字段
- [ ] 描述能让 agent 判断该用哪个 action
## Action JSON 文件结构
```json
{
"type": "LiquidHandlerTransfer", // → API 的 action_type
"goal": { // goal 字段映射
"sources": "sources",
"targets": "targets",
"tip_racks": "tip_racks",
"asp_vols": "asp_vols"
},
"schema": { // ← 直接是 goal 的 schema已提升
"type": "object",
"properties": { // 参数定义(即请求中 goal 的字段)
"sources": { "type": "array", "items": { "type": "object" } },
"targets": { "type": "array", "items": { "type": "object" } },
"asp_vols": { "type": "array", "items": { "type": "number" } }
},
"required": [...],
"_unilabos_placeholder_info": { // ← Slot 类型标记
"sources": "unilabos_resources",
"targets": "unilabos_resources",
"tip_racks": "unilabos_resources"
}
},
"goal_default": { ... }, // 默认值
"placeholder_keys": { // ← 汇总所有 Slot 字段
"sources": "unilabos_resources", // ResourceSlot
"targets": "unilabos_resources",
"tip_racks": "unilabos_resources",
"target_device_id": "unilabos_devices" // DeviceSlot
}
}
```
> **注意**`schema` 已由脚本从原始 `schema.properties.goal` 提升为顶层,直接包含参数定义。
> `schema.properties` 中的字段即为 API 创建节点返回的 `data.param` 中的字段PATCH 更新时直接修改 `param` 即可。
## Placeholder Slot 类型体系
`placeholder_keys` / `_unilabos_placeholder_info` 中有 5 种值,对应不同的填写方式:
| placeholder 值 | Slot 类型 | 填写格式 | 选取范围 |
|---------------|-----------|---------|---------|
| `unilabos_resources` | ResourceSlot | `{"id": "/path/name", "name": "name", "uuid": "xxx"}` | 仅**物料**节点(不含设备) |
| `unilabos_devices` | DeviceSlot | `"/parent/device_name"` | 仅**设备**节点type=device路径字符串 |
| `unilabos_nodes` | NodeSlot | `"/parent/node_name"` | **设备 + 物料**,即所有节点,路径字符串 |
| `unilabos_class` | ClassSlot | `"class_name"` | 注册表中已上报的资源类 name |
| `unilabos_formulation` | FormulationSlot | `[{well_name, liquids: [{name, volume}]}]` | 资源树中物料节点的 **name**,配合液体配方 |
### ResourceSlot`unilabos_resources`
最常见的类型。从资源树中选取**物料**节点(孔板、枪头盒、试剂槽等):
```json
{"id": "/workstation/container1", "name": "container1", "uuid": "ff149a9a-2cb8-419d-8db5-d3ba056fb3c2"}
```
- 单个schema type=object`{"id": "/path/name", "name": "name", "uuid": "xxx"}`
- 数组schema type=array`[{"id": "/path/a", "name": "a", "uuid": "xxx"}, ...]`
- `id` 本身是从 parent 计算的路径格式
- 根据 action 语义选择正确的物料(如 `sources` = 液体来源,`targets` = 目标位置)
> **特例**`create_resource` 的 `res_id` 字段,目标物料可能**尚不存在**,此时直接填写期望的路径(如 `"/workstation/container1"`),不需要 uuid。
### DeviceSlot`unilabos_devices`
填写**设备路径字符串**。从资源树中筛选 type=device 的节点,从 parent 计算路径:
```
"/host_node"
"/bioyond_cell/reaction_station"
```
- 只填路径字符串,不需要 `{id, uuid}` 对象
- 根据 action 语义选择正确的设备(如 `target_device_id` = 目标设备)
### NodeSlot`unilabos_nodes`
范围 = 设备 + 物料。即资源树中**所有节点**都可以选,填写**路径字符串**
```
"/PRCXI/PRCXI_Deck"
```
- 使用场景:当参数既可能指向物料也可能指向设备时(如 `PumpTransferProtocol``from_vessel`/`to_vessel``create_resource``parent`
### ClassSlot`unilabos_class`
填写注册表中已上报的**资源类 name**。从本地 `req_resource_registry_upload.json` 中查找:
```
"container"
```
### FormulationSlot`unilabos_formulation`
描述**液体配方**:向哪些物料容器中加入哪些液体及体积。填写为**对象数组**
```json
[
{
"sample_uuid": "",
"well_name": "YB_PrepBottle_15mL_Carrier_bottle_A1",
"liquids": [
{ "name": "LiPF6", "volume": 0.6 },
{ "name": "DMC", "volume": 1.2 }
]
}
]
```
#### 字段说明
| 字段 | 类型 | 说明 |
|------|------|------|
| `sample_uuid` | string | 样品 UUID无样品时传空字符串 `""` |
| `well_name` | string | 目标物料容器的 **name**(从资源树中取物料节点的 `name` 字段,如瓶子、孔位名称) |
| `liquids` | array | 要加入的液体列表 |
| `liquids[].name` | string | 液体名称(如试剂名、溶剂名) |
| `liquids[].volume` | number | 液体体积(单位由设备决定,通常为 mL |
#### 填写规则
- `well_name` 必须是资源树中已存在的物料节点 `name`(不是 `id` 路径),通过 API #12 获取资源树后筛选
- 每个数组元素代表一个目标容器的配方
- 一个容器可以加入多种液体(`liquids` 数组多条记录)
- 与 ResourceSlot 的区别ResourceSlot 填 `{id, name, uuid}` 指向物料本身FormulationSlot 用 `well_name` 引用物料,并附带液体配方信息
### 通过 API #12 获取资源树
```bash
curl -s -X GET "$BASE/api/v1/lab/material/download/$lab_uuid" -H "$AUTH"
```
注意 `lab_uuid` 在路径中(不是查询参数)。资源树返回所有节点,每个节点包含 `id`(路径格式)、`name``uuid``type``parent` 等字段。填写 Slot 时需根据 placeholder 类型筛选正确的节点。
## 最终目录结构
```
./<skill-name>/
├── SKILL.md # API 端点 + 渐进加载指引
├── action-index.md # 动作索引:描述/用途/核心参数
└── actions/ # 每个 action 的完整 JSON Schema
├── action1.json
├── action2.json
└── ...
```

View File

@@ -0,0 +1,200 @@
#!/usr/bin/env python3
"""
从 req_device_registry_upload.json 中提取指定设备的 action schema。
用法:
# 列出所有设备及 action 数量(自动搜索注册表文件)
python extract_device_actions.py
# 指定注册表文件路径
python extract_device_actions.py --registry <path/to/req_device_registry_upload.json>
# 提取指定设备的 action 到目录
python extract_device_actions.py <device_id> <output_dir>
python extract_device_actions.py --registry <path> <device_id> <output_dir>
示例:
python extract_device_actions.py --registry unilabos_data/req_device_registry_upload.json
python extract_device_actions.py liquid_handler.prcxi .cursor/skills/unilab-device-api/actions/
"""
import json
import os
import sys
from datetime import datetime
REGISTRY_FILENAME = "req_device_registry_upload.json"
def find_registry(explicit_path=None):
"""
查找 req_device_registry_upload.json 文件。
搜索优先级:
1. 用户通过 --registry 显式指定的路径
2. <cwd>/unilabos_data/req_device_registry_upload.json
3. <cwd>/req_device_registry_upload.json
4. <script所在目录>/../../.. (workspace根) 下的 unilabos_data/
5. 向上逐级搜索父目录(最多 5 层)
"""
if explicit_path:
if os.path.isfile(explicit_path):
return explicit_path
if os.path.isdir(explicit_path):
fp = os.path.join(explicit_path, REGISTRY_FILENAME)
if os.path.isfile(fp):
return fp
print(f"警告: 指定的路径不存在: {explicit_path}")
return None
candidates = [
os.path.join("unilabos_data", REGISTRY_FILENAME),
REGISTRY_FILENAME,
]
for c in candidates:
if os.path.isfile(c):
return c
script_dir = os.path.dirname(os.path.abspath(__file__))
workspace_root = os.path.normpath(os.path.join(script_dir, "..", "..", ".."))
for c in candidates:
path = os.path.join(workspace_root, c)
if os.path.isfile(path):
return path
cwd = os.getcwd()
for _ in range(5):
parent = os.path.dirname(cwd)
if parent == cwd:
break
cwd = parent
for c in candidates:
path = os.path.join(cwd, c)
if os.path.isfile(path):
return path
return None
def load_registry(path):
with open(path, 'r', encoding='utf-8') as f:
return json.load(f)
def list_devices(data):
"""列出所有包含 action_value_mappings 的设备,同时返回 module 路径"""
resources = data.get('resources', [])
devices = []
for res in resources:
rid = res.get('id', '')
cls = res.get('class', {})
avm = cls.get('action_value_mappings', {})
module = cls.get('module', '')
if avm:
devices.append((rid, len(avm), module))
return devices
def flatten_schema_to_goal(action_data):
"""将 schema 中嵌套的 goal 内容提升为顶层 schema去掉 feedback/result 包装"""
schema = action_data.get('schema', {})
goal_schema = schema.get('properties', {}).get('goal', {})
if goal_schema:
action_data = dict(action_data)
action_data['schema'] = goal_schema
return action_data
def extract_actions(data, device_id, output_dir):
"""提取指定设备的 action schema 到独立 JSON 文件"""
resources = data.get('resources', [])
for res in resources:
if res.get('id') == device_id:
cls = res.get('class', {})
module = cls.get('module', '')
avm = cls.get('action_value_mappings', {})
if not avm:
print(f"设备 {device_id} 没有 action_value_mappings")
return []
if module:
py_path = module.split(":")[0].replace(".", "/") + ".py"
class_name = module.split(":")[-1] if ":" in module else ""
print(f"Python 源码: {py_path}")
if class_name:
print(f"设备类: {class_name}")
os.makedirs(output_dir, exist_ok=True)
written = []
for action_name in sorted(avm.keys()):
action_data = flatten_schema_to_goal(avm[action_name])
filename = action_name.replace('-', '_') + '.json'
filepath = os.path.join(output_dir, filename)
with open(filepath, 'w', encoding='utf-8') as f:
json.dump(action_data, f, indent=2, ensure_ascii=False)
written.append(filename)
print(f" {filepath}")
return written
print(f"设备 {device_id} 未找到")
return []
def main():
args = sys.argv[1:]
explicit_registry = None
if "--registry" in args:
idx = args.index("--registry")
if idx + 1 < len(args):
explicit_registry = args[idx + 1]
args = args[:idx] + args[idx + 2:]
else:
print("错误: --registry 需要指定路径")
sys.exit(1)
registry_path = find_registry(explicit_registry)
if not registry_path:
print(f"错误: 找不到 {REGISTRY_FILENAME}")
print()
print("解决方法:")
print(" 1. 先运行 unilab 启动命令,等待注册表生成")
print(" 2. 用 --registry 指定文件路径:")
print(f" python {sys.argv[0]} --registry <path/to/{REGISTRY_FILENAME}>")
print()
print("搜索过的路径:")
for p in [
os.path.join("unilabos_data", REGISTRY_FILENAME),
REGISTRY_FILENAME,
os.path.join("<workspace_root>", "unilabos_data", REGISTRY_FILENAME),
]:
print(f" - {p}")
sys.exit(1)
print(f"注册表: {registry_path}")
mtime = os.path.getmtime(registry_path)
gen_time = datetime.fromtimestamp(mtime).strftime("%Y-%m-%d %H:%M:%S")
size_mb = os.path.getsize(registry_path) / (1024 * 1024)
print(f"生成时间: {gen_time} (文件大小: {size_mb:.1f} MB)")
data = load_registry(registry_path)
if len(args) == 0:
devices = list_devices(data)
print(f"\n找到 {len(devices)} 个设备:")
print(f"{'设备 ID':<50} {'Actions':>7} {'Python 模块'}")
print("-" * 120)
for did, count, module in sorted(devices, key=lambda x: x[0]):
py_path = module.split(":")[0].replace(".", "/") + ".py" if module else ""
print(f"{did:<50} {count:>7} {py_path}")
elif len(args) == 2:
device_id = args[0]
output_dir = args[1]
print(f"\n提取 {device_id} 的 actions 到 {output_dir}/")
written = extract_actions(data, device_id, output_dir)
if written:
print(f"\n共写入 {len(written)} 个 action 文件")
else:
print("用法:")
print(" python extract_device_actions.py [--registry <path>] # 列出设备")
print(" python extract_device_actions.py [--registry <path>] <device_id> <dir> # 提取 actions")
sys.exit(1)
if __name__ == '__main__':
main()

View File

@@ -0,0 +1,69 @@
#!/usr/bin/env python3
"""
从 ak/sk 生成 UniLab API Authorization header。
算法: base64(ak:sk) → "Authorization: Lab <token>"
用法:
python gen_auth.py <ak> <sk>
python gen_auth.py --config <config.py>
示例:
python gen_auth.py myak mysk
python gen_auth.py --config experiments/config.py
"""
import base64
import re
import sys
def gen_auth(ak: str, sk: str) -> str:
token = base64.b64encode(f"{ak}:{sk}".encode("utf-8")).decode("utf-8")
return token
def extract_from_config(config_path: str) -> tuple:
"""从 config.py 中提取 ak 和 sk"""
with open(config_path, "r", encoding="utf-8") as f:
content = f.read()
ak_match = re.search(r'''ak\s*=\s*["']([^"']+)["']''', content)
sk_match = re.search(r'''sk\s*=\s*["']([^"']+)["']''', content)
if not ak_match or not sk_match:
return None, None
return ak_match.group(1), sk_match.group(1)
def main():
args = sys.argv[1:]
if len(args) == 2 and args[0] == "--config":
ak, sk = extract_from_config(args[1])
if not ak or not sk:
print(f"错误: 在 {args[1]} 中未找到 ak/sk 配置")
print("期望格式: ak = \"xxx\" sk = \"xxx\"")
sys.exit(1)
print(f"配置文件: {args[1]}")
elif len(args) == 2:
ak, sk = args
else:
print("用法:")
print(" python gen_auth.py <ak> <sk>")
print(" python gen_auth.py --config <config.py>")
sys.exit(1)
token = gen_auth(ak, sk)
print(f"ak: {ak}")
print(f"sk: {sk}")
print()
print(f"Authorization header:")
print(f" Authorization: Lab {token}")
print()
print(f"curl 用法:")
print(f' curl -H "Authorization: Lab {token}" ...')
print()
print(f"Shell 变量:")
print(f' AUTH="Authorization: Lab {token}"')
if __name__ == "__main__":
main()

View File

@@ -0,0 +1,275 @@
---
name: submit-agent-result
description: Submit historical experiment results (agent_result) to Uni-Lab notebook — read data files, assemble JSON payload, PUT to cloud API. Use when the user wants to submit experiment results, upload agent results, report experiment data, or mentions agent_result/实验结果/历史记录/notebook结果.
---
# 提交历史实验记录指南
通过云端 API 向已创建的 notebook 提交实验结果数据agent_result。支持从 JSON / CSV 文件读取数据,整合后提交。
## 前置条件(缺一不可)
使用本指南前,**必须**先确认以下信息。如果缺少任何一项,**立即向用户询问并终止**,等补齐后再继续。
### 1. ak / sk → AUTH
询问用户的启动参数,从 `--ak` `--sk` 或 config.py 中获取。
生成 AUTH token
```bash
python -c "import base64,sys; print(base64.b64encode(f'{sys.argv[1]}:{sys.argv[2]}'.encode()).decode())" <ak> <sk>
```
输出即为 token 值,拼接为 `Authorization: Lab <token>`
### 2. --addr → BASE URL
| `--addr` 值 | BASE |
|-------------|------|
| `test` | `https://uni-lab.test.bohrium.com` |
| `uat` | `https://uni-lab.uat.bohrium.com` |
| `local` | `http://127.0.0.1:48197` |
| 不传(默认) | `https://uni-lab.bohrium.com` |
确认后设置:
```bash
BASE="<根据 addr 确定的 URL>"
AUTH="Authorization: Lab <上面命令输出的 token>"
```
### 3. notebook_uuid**必须询问用户**
**必须主动询问用户**:「请提供要提交结果的 notebook UUID。」
notebook_uuid 来自之前通过「批量提交实验」创建的实验批次,即 `POST /api/v1/lab/notebook` 返回的 `data.uuid`
如果用户不记得,可提示:
- 查看之前的对话记录中创建 notebook 时返回的 UUID
- 或通过平台页面查找对应的 notebook
**绝不能跳过此步骤,没有 notebook_uuid 无法提交。**
### 4. 实验结果数据
用户需要提供实验结果数据,支持以下方式:
| 方式 | 说明 |
|------|------|
| JSON 文件 | 直接作为 `agent_result` 的内容合并 |
| CSV 文件 | 转为 `{"文件名": [行数据...]}` 格式 |
| 手动指定 | 用户直接告知 key-value 数据,由 agent 构建 JSON |
**四项全部就绪后才可开始。**
## Session State
在整个对话过程中agent 需要记住以下状态:
- `lab_uuid` — 实验室 UUID通过 API #1 自动获取,**不需要问用户**
- `notebook_uuid` — 目标 notebook UUID**必须询问用户**
## 请求约定
所有请求使用 `curl -s`PUT 需加 `Content-Type: application/json`
> **Windows 平台**必须使用 `curl.exe`(而非 PowerShell 的 `curl` 别名),示例中的 `curl` 均指 `curl.exe`。
>
> **PowerShell JSON 传参**PowerShell 中 `-d '{"key":"value"}'` 会因引号转义失败。请将 JSON 写入临时文件,用 `-d '@tmp_body.json'`(单引号包裹 `@`,否则 `@` 会被 PowerShell 解析为 splatting 运算符导致报错)。
---
## API Endpoints
### 1. 获取实验室信息(自动获取 lab_uuid
```bash
curl -s -X GET "$BASE/api/v1/edge/lab/info" -H "$AUTH"
```
返回:
```json
{"code": 0, "data": {"uuid": "xxx", "name": "实验室名称"}}
```
记住 `data.uuid``lab_uuid`
### 2. 提交实验结果agent_result
```bash
curl -s -X PUT "$BASE/api/v1/lab/notebook/agent-result" \
-H "$AUTH" -H "Content-Type: application/json" \
-d '<request_body>'
```
请求体结构:
```json
{
"notebook_uuid": "<notebook_uuid>",
"agent_result": {
"<key1>": "<value1>",
"<key2>": 123,
"<nested_key>": {"a": 1, "b": 2},
"<array_key>": [{"col1": "v1", "col2": "v2"}, ...]
}
}
```
> **注意**HTTP 方法是 **PUT**(不是 POST
#### 必要字段
| 字段 | 类型 | 说明 |
|------|------|------|
| `notebook_uuid` | string (UUID) | 目标 notebook 的 UUID从批量提交实验时获取 |
| `agent_result` | object | 实验结果数据,任意 JSON 对象 |
#### agent_result 内容格式
`agent_result` 接受**任意 JSON 对象**,常见格式:
**简单键值对**
```json
{
"avg_rtt_ms": 12.5,
"status": "success",
"test_count": 5
}
```
**包含嵌套结构**
```json
{
"summary": {"total": 100, "passed": 98, "failed": 2},
"measurements": [
{"sample_id": "S001", "value": 3.14, "unit": "mg/mL"},
{"sample_id": "S002", "value": 2.71, "unit": "mg/mL"}
]
}
```
**从 CSV 文件导入**(脚本自动转换):
```json
{
"experiment_data": [
{"温度": 25, "压力": 101.3, "产率": 0.85},
{"温度": 30, "压力": 101.3, "产率": 0.91}
]
}
```
---
## 整合脚本
本文档同级目录下的 `scripts/prepare_agent_result.py` 可自动读取文件并构建请求体。
### 用法
```bash
python scripts/prepare_agent_result.py \
--notebook-uuid <uuid> \
--files data1.json data2.csv \
[--auth <token>] \
[--base <BASE_URL>] \
[--submit] \
[--output <output.json>]
```
| 参数 | 必选 | 说明 |
|------|------|------|
| `--notebook-uuid` | 是 | 目标 notebook UUID |
| `--files` | 是 | 输入文件路径支持多个JSON / CSV |
| `--auth` | 提交时必选 | Lab tokenbase64(ak:sk) |
| `--base` | 提交时必选 | API base URL |
| `--submit` | 否 | 加上此标志则直接提交到云端 |
| `--output` | 否 | 输出 JSON 路径(默认 `agent_result_body.json` |
### 文件合并规则
| 文件类型 | 合并方式 |
|----------|----------|
| `.json`dict | 字段直接合并到 `agent_result` 顶层 |
| `.json`list/other | 以文件名为 key 放入 `agent_result` |
| `.csv` | 以文件名(不含扩展名)为 key值为行对象数组 |
多个文件的字段会合并。JSON dict 中的重复 key 后者覆盖前者。
### 示例
```bash
# 仅生成请求体文件(不提交)
python scripts/prepare_agent_result.py \
--notebook-uuid 73c67dca-c8cc-4936-85a0-329106aa7cca \
--files results.json measurements.csv
# 生成并直接提交
python scripts/prepare_agent_result.py \
--notebook-uuid 73c67dca-c8cc-4936-85a0-329106aa7cca \
--files results.json \
--auth YTFmZDlkNGUt... \
--base https://uni-lab.test.bohrium.com \
--submit
```
---
## 手动构建方式
如果不使用脚本,也可手动构建请求体:
1. 将实验结果数据组装为 JSON 对象
2. 写入临时文件:
```json
{
"notebook_uuid": "<uuid>",
"agent_result": { ... }
}
```
3. 用 curl 提交:
```bash
curl -s -X PUT "$BASE/api/v1/lab/notebook/agent-result" \
-H "$AUTH" -H "Content-Type: application/json" \
-d '@tmp_body.json'
```
---
## 完整工作流 Checklist
```
Task Progress:
- [ ] Step 1: 确认 ak/sk → 生成 AUTH token
- [ ] Step 2: 确认 --addr → 设置 BASE URL
- [ ] Step 3: GET /edge/lab/info → 获取 lab_uuid
- [ ] Step 4: **询问用户** notebook_uuid必须不可跳过
- [ ] Step 5: 确认实验结果数据来源(文件路径或手动数据)
- [ ] Step 6: 运行 prepare_agent_result.py 或手动构建请求体
- [ ] Step 7: PUT /lab/notebook/agent-result 提交
- [ ] Step 8: 检查返回结果,确认提交成功
```
---
## 常见问题
### Q: notebook_uuid 从哪里获取?
从之前「批量提交实验」时 `POST /api/v1/lab/notebook` 的返回值 `data.uuid` 获取。也可以在平台 UI 中查找对应的 notebook。
### Q: agent_result 有固定的 schema 吗?
没有严格 schema接受任意 JSON 对象。但建议包含有意义的字段名和结构化数据,方便后续分析。
### Q: 可以多次提交同一个 notebook 的结果吗?
可以,后续提交会覆盖之前的 agent_result。
### Q: 认证方式是 Lab 还是 Api
本指南统一使用 `Authorization: Lab <base64(ak:sk)>` 方式。如果用户有独立的 API Key也可用 `Authorization: Api <key>` 替代。

View File

@@ -0,0 +1,133 @@
"""
读取实验结果文件JSON / CSV整合为 agent_result 请求体并可选提交。
用法:
python prepare_agent_result.py \
--notebook-uuid <uuid> \
--files data1.json data2.csv \
[--auth <Lab token>] \
[--base <BASE_URL>] \
[--submit] \
[--output <output.json>]
支持的输入文件格式:
- .json → 直接作为 dict 合并
- .csv → 转为 {"filename": [row_dict, ...]} 格式
"""
import argparse
import base64
import csv
import json
import os
import sys
from pathlib import Path
from typing import Any, Dict, List
def read_json_file(filepath: str) -> Dict[str, Any]:
with open(filepath, "r", encoding="utf-8") as f:
return json.load(f)
def read_csv_file(filepath: str) -> List[Dict[str, Any]]:
rows = []
with open(filepath, "r", encoding="utf-8-sig") as f:
reader = csv.DictReader(f)
for row in reader:
converted = {}
for k, v in row.items():
try:
converted[k] = int(v)
except (ValueError, TypeError):
try:
converted[k] = float(v)
except (ValueError, TypeError):
converted[k] = v
rows.append(converted)
return rows
def merge_files(filepaths: List[str]) -> Dict[str, Any]:
"""将多个文件合并为一个 agent_result dict"""
merged: Dict[str, Any] = {}
for fp in filepaths:
path = Path(fp)
ext = path.suffix.lower()
key = path.stem
if ext == ".json":
data = read_json_file(fp)
if isinstance(data, dict):
merged.update(data)
else:
merged[key] = data
elif ext == ".csv":
merged[key] = read_csv_file(fp)
else:
print(f"[警告] 不支持的文件格式: {fp},跳过", file=sys.stderr)
return merged
def build_request_body(notebook_uuid: str, agent_result: Dict[str, Any]) -> Dict[str, Any]:
return {
"notebook_uuid": notebook_uuid,
"agent_result": agent_result,
}
def submit(base: str, auth: str, body: Dict[str, Any]) -> Dict[str, Any]:
try:
import requests
except ImportError:
print("[错误] 提交需要 requests 库: pip install requests", file=sys.stderr)
sys.exit(1)
url = f"{base}/api/v1/lab/notebook/agent-result"
headers = {
"Content-Type": "application/json",
"Authorization": f"Lab {auth}",
}
resp = requests.put(url, json=body, headers=headers, timeout=30)
return {"status_code": resp.status_code, "body": resp.json() if resp.headers.get("content-type", "").startswith("application/json") else resp.text}
def main():
parser = argparse.ArgumentParser(description="整合实验结果文件并构建 agent_result 请求体")
parser.add_argument("--notebook-uuid", required=True, help="目标 notebook UUID")
parser.add_argument("--files", nargs="+", required=True, help="输入文件路径JSON / CSV")
parser.add_argument("--auth", help="Lab tokenbase64(ak:sk)")
parser.add_argument("--base", help="API base URL")
parser.add_argument("--submit", action="store_true", help="直接提交到云端")
parser.add_argument("--output", default="agent_result_body.json", help="输出 JSON 文件路径")
args = parser.parse_args()
for fp in args.files:
if not os.path.exists(fp):
print(f"[错误] 文件不存在: {fp}", file=sys.stderr)
sys.exit(1)
agent_result = merge_files(args.files)
body = build_request_body(args.notebook_uuid, agent_result)
with open(args.output, "w", encoding="utf-8") as f:
json.dump(body, f, ensure_ascii=False, indent=2)
print(f"[完成] 请求体已保存: {args.output}")
print(f" notebook_uuid: {args.notebook_uuid}")
print(f" agent_result 字段数: {len(agent_result)}")
print(f" 合并文件数: {len(args.files)}")
if args.submit:
if not args.auth or not args.base:
print("[错误] 提交需要 --auth 和 --base 参数", file=sys.stderr)
sys.exit(1)
print(f"\n[提交] PUT {args.base}/api/v1/lab/notebook/agent-result ...")
result = submit(args.base, args.auth, body)
print(f" HTTP {result['status_code']}")
print(f" 响应: {json.dumps(result['body'], ensure_ascii=False)}")
if __name__ == "__main__":
main()

View File

@@ -1,26 +0,0 @@
.conda
# .github
.idea
# .vscode
output
pylabrobot_repo
recipes
scripts
service
temp
# unilabos/test
# unilabos/app/web
unilabos/device_mesh
unilabos_data
unilabos_msgs
unilabos.egg-info
CONTRIBUTORS
# LICENSE
MANIFEST.in
pyrightconfig.json
# README.md
# README_zh.md
setup.py
setup.cfg
.gitattrubutes
**/__pycache__

19
.github/dependabot.yml vendored Normal file
View File

@@ -0,0 +1,19 @@
version: 2
updates:
# GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
target-branch: "dev"
schedule:
interval: "weekly"
day: "monday"
time: "06:00"
open-pull-requests-limit: 5
reviewers:
- "msgcenterpy-team"
labels:
- "dependencies"
- "github-actions"
commit-message:
prefix: "ci"
include: "scope"

2
.gitignore vendored
View File

@@ -252,5 +252,3 @@ ros-humble-unilabos-msgs-0.9.13-h6403a04_5.tar.bz2
test_config.py
/.claude
/.cursor

View File

@@ -1,95 +1,4 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
Please follow the rules defined in:
## Build & Development
```bash
# Install (requires mamba env with python 3.11)
mamba create -n unilab python=3.11.14
mamba activate unilab
mamba install uni-lab::unilabos-env -c robostack-staging -c conda-forge
pip install -e .
uv pip install -r unilabos/utils/requirements.txt
# Run with a device graph
unilab --graph <graph.json> --config <config.py> --backend ros
unilab --graph <graph.json> --config <config.py> --backend simple # no ROS2 needed
# Common CLI flags
unilab --app_bridges websocket fastapi # communication bridges
unilab --test_mode # simulate hardware, no real execution
unilab --check_mode # CI validation of registry imports (AST-based)
unilab --skip_env_check # skip auto-install of dependencies
unilab --visual rviz|web|disable # visualization mode
unilab --is_slave # run as slave node
unilab --restart_mode # auto-restart on config changes (supervisor/child process)
# Workflow upload subcommand
unilab workflow_upload -f <workflow.json> -n <name> --tags tag1 tag2
# Tests
pytest tests/ # all tests
pytest tests/resources/test_resourcetreeset.py # single test file
pytest tests/resources/test_resourcetreeset.py::TestClassName::test_method # single test
# CI check (matches .github/workflows/ci-check.yml)
python -m unilabos --check_mode --skip_env_check
```
## Architecture
### Startup Flow
`unilab` CLI (entry point in `setup.py`) → `unilabos/app/main.py:main()` → loads config → builds registry → reads device graph (JSON/GraphML) → starts backend thread (ROS2/simple) → starts FastAPI web server + WebSocket client.
### Core Layers
**Registry** (`unilabos/registry/`): Singleton `Registry` class discovers and catalogs all device types, resource types, and communication devices. Two registration mechanisms: YAML definitions in `registry/devices/*.yaml` and Python decorators (`@device`, `@action`, `@resource` in `registry/decorators.py`). AST scanning discovers decorated classes without importing them. Class paths resolved to Python classes via `utils/import_manager.py`.
**Resource Tracking** (`unilabos/resources/resource_tracker.py`): Pydantic-based `ResourceDict``ResourceDictInstance``ResourceTreeSet` hierarchy. `ResourceTreeSet` is the canonical in-memory representation of all devices and resources. Graph I/O in `resources/graphio.py` reads JSON/GraphML device topology files into `nx.Graph` + `ResourceTreeSet`.
**Device Drivers** (`unilabos/devices/`): 30+ hardware drivers organized by category (liquid_handling, hplc, balance, arm, etc.). Each driver class gets wrapped by `ros/device_node_wrapper.py:ros2_device_node()` into a `ROS2DeviceNode` (defined in `ros/nodes/base_device_node.py`) with publishers, subscribers, and action servers.
**ROS2 Layer** (`unilabos/ros/`): Preset node types in `ros/nodes/presets/``host_node` (main orchestrator, ~90KB), `controller_node`, `workstation`, `serial_node`, `camera`, `resource_mesh_manager`. Custom messages in `unilabos_msgs/` (80+ action types, pre-built via conda `ros-humble-unilabos-msgs`).
**Protocol Compilation** (`unilabos/compile/`): 20+ protocol compilers (add, centrifuge, dissolve, filter, heatchill, stir, pump, etc.) registered in `__init__.py:action_protocol_generators` dict. Utility parsers in `compile/utils/` (vessel, unit, logger).
**Workflow** (`unilabos/workflow/`): Converts workflow definitions from multiple formats — JSON (`convert_from_json.py`, `common.py`), Python scripts (`from_python_script.py`), XDL (`from_xdl.py`) — into executable `WorkflowGraph`. Legacy converters in `workflow/legacy/`.
**Communication** (`unilabos/device_comms/`): Hardware adapters — OPC-UA, Modbus PLC, RPC, universal driver. `app/communication.py` provides factory pattern for WebSocket connections.
**Web/API** (`unilabos/app/web/`): FastAPI server with REST API (`api.py`), Jinja2 templates (`pages.py`), HTTP client (`client.py`). Default port 8002.
### Configuration System
- **Config classes** in `unilabos/config/config.py`: `BasicConfig`, `WSConfig`, `HTTPConfig`, `ROSConfig` — class-level attributes, loaded from Python `.py` config files (see `config/example_config.py`)
- Environment variable overrides with prefix `UNILABOS_` (e.g., `UNILABOS_BASICCONFIG_PORT=9000`)
- Device topology defined in graph files (JSON node-link format or GraphML)
### Key Data Flow
1. Graph file → `graphio.read_node_link_json()``(nx.Graph, ResourceTreeSet, resource_links)`
2. `ResourceTreeSet` + `Registry``initialize_device.initialize_device_from_dict()``ROS2DeviceNode` instances
3. Device nodes communicate via ROS2 topics/actions or direct Python calls (simple backend)
4. Cloud sync via WebSocket (`app/ws_client.py`) and HTTP (`app/web/client.py`)
### Test Data
Example device graphs and experiment configs are in `unilabos/test/experiments/` (not `tests/`). Registry test fixtures in `unilabos/test/registry/`.
## Code Conventions
- Code comments and log messages in **simplified Chinese**
- Python 3.11+, type hints expected
- Pydantic models for data validation (`resource_tracker.py`)
- Singleton pattern via `@singleton` decorator (`utils/decorator.py`)
- Dynamic class loading via `utils/import_manager.py` — device classes resolved at runtime from registry YAML paths
- CLI argument dashes auto-converted to underscores for consistency
- No linter/formatter configuration enforced (no ruff, black, flake8, mypy configs)
- Documentation built with Sphinx (Chinese language, `sphinx_rtd_theme`, `myst_parser`)
## Licensing
- Framework code: GPL-3.0
- Device drivers (`unilabos/devices/`): DP Technology Proprietary License — do not redistribute
@AGENTS.md

File diff suppressed because it is too large Load Diff

View File

@@ -1,539 +0,0 @@
import pytest
import json
import os
import asyncio
import collections
from typing import List, Dict, Any
from pylabrobot.resources import Coordinate
from pylabrobot.resources.opentrons.tip_racks import opentrons_96_tiprack_300ul, opentrons_96_tiprack_10ul
from pylabrobot.resources.opentrons.plates import corning_96_wellplate_360ul_flat, nest_96_wellplate_2ml_deep
from unilabos.devices.liquid_handling.prcxi.prcxi import (
PRCXI9300Deck,
PRCXI9300Container,
PRCXI9300Trash,
PRCXI9300Handler,
PRCXI9300Backend,
DefaultLayout,
Material,
WorkTablets,
MatrixInfo
)
@pytest.fixture
def prcxi_materials() -> Dict[str, Any]:
"""加载 PRCXI 物料数据"""
print("加载 PRCXI 物料数据...")
material_path = os.path.join(os.path.dirname(__file__), "..", "..", "unilabos", "devices", "liquid_handling", "prcxi", "prcxi_material.json")
with open(material_path, "r", encoding="utf-8") as f:
data = json.load(f)
print(f"加载了 {len(data)} 条物料数据")
return data
@pytest.fixture
def prcxi_9300_deck() -> PRCXI9300Deck:
"""创建 PRCXI 9300 工作台"""
return PRCXI9300Deck(name="PRCXI_Deck_9300", size_x=100, size_y=100, size_z=100, model="9300")
@pytest.fixture
def prcxi_9320_deck() -> PRCXI9300Deck:
"""创建 PRCXI 9320 工作台"""
return PRCXI9300Deck(name="PRCXI_Deck_9320", size_x=100, size_y=100, size_z=100, model="9320")
@pytest.fixture
def prcxi_9300_handler(prcxi_9300_deck) -> PRCXI9300Handler:
"""创建 PRCXI 9300 处理器(模拟模式)"""
return PRCXI9300Handler(
deck=prcxi_9300_deck,
host="192.168.1.201",
port=9999,
timeout=10.0,
channel_num=8,
axis="Left",
setup=False,
debug=True,
simulator=True,
matrix_id="test-matrix-9300"
)
@pytest.fixture
def prcxi_9320_handler(prcxi_9320_deck) -> PRCXI9300Handler:
"""创建 PRCXI 9320 处理器(模拟模式)"""
return PRCXI9300Handler(
deck=prcxi_9320_deck,
host="192.168.1.201",
port=9999,
timeout=10.0,
channel_num=1,
axis="Right",
setup=False,
debug=True,
simulator=True,
matrix_id="test-matrix-9320",
is_9320=True
)
@pytest.fixture
def tip_rack_300ul(prcxi_materials) -> PRCXI9300Container:
"""创建 300μL 枪头盒"""
tip_rack = PRCXI9300Container(
name="tip_rack_300ul",
size_x=50,
size_y=50,
size_z=10,
category="tip_rack",
ordering=collections.OrderedDict()
)
tip_rack.load_state({
"Material": {
"uuid": prcxi_materials["300μL Tip头"]["uuid"],
"Code": "ZX-001-300",
"Name": "300μL Tip头"
}
})
return tip_rack
@pytest.fixture
def tip_rack_10ul(prcxi_materials) -> PRCXI9300Container:
"""创建 10μL 枪头盒"""
tip_rack = PRCXI9300Container(
name="tip_rack_10ul",
size_x=50,
size_y=50,
size_z=10,
category="tip_rack",
ordering=collections.OrderedDict()
)
tip_rack.load_state({
"Material": {
"uuid": prcxi_materials["10μL加长 Tip头"]["uuid"],
"Code": "ZX-001-10+",
"Name": "10μL加长 Tip头"
}
})
return tip_rack
@pytest.fixture
def well_plate_96(prcxi_materials) -> PRCXI9300Container:
"""创建 96 孔板"""
plate = PRCXI9300Container(
name="well_plate_96",
size_x=50,
size_y=50,
size_z=10,
category="plate",
ordering=collections.OrderedDict()
)
plate.load_state({
"Material": {
"uuid": prcxi_materials["96深孔板"]["uuid"],
"Code": "ZX-019-2.2",
"Name": "96深孔板"
}
})
return plate
@pytest.fixture
def deep_well_plate(prcxi_materials) -> PRCXI9300Container:
"""创建深孔板"""
plate = PRCXI9300Container(
name="deep_well_plate",
size_x=50,
size_y=50,
size_z=10,
category="plate",
ordering=collections.OrderedDict()
)
plate.load_state({
"Material": {
"uuid": prcxi_materials["96深孔板"]["uuid"],
"Code": "ZX-019-2.2",
"Name": "96深孔板"
}
})
return plate
@pytest.fixture
def trash_container(prcxi_materials) -> PRCXI9300Trash:
"""创建垃圾桶"""
trash = PRCXI9300Trash(name="trash", size_x=50, size_y=50, size_z=10, category="trash")
trash.load_state({
"Material": {
"uuid": prcxi_materials["废弃槽"]["uuid"]
}
})
return trash
@pytest.fixture
def default_layout_9300() -> DefaultLayout:
"""创建 PRCXI 9300 默认布局"""
return DefaultLayout("PRCXI9300")
@pytest.fixture
def default_layout_9320() -> DefaultLayout:
"""创建 PRCXI 9320 默认布局"""
return DefaultLayout("PRCXI9320")
class TestPRCXIDeckSetup:
"""测试 PRCXI 工作台设置功能"""
def test_prcxi_9300_deck_creation(self, prcxi_9300_deck):
"""测试 PRCXI 9300 工作台创建"""
assert prcxi_9300_deck.name == "PRCXI_Deck_9300"
assert len(prcxi_9300_deck.sites) == 6
assert prcxi_9300_deck._size_x == 100
assert prcxi_9300_deck._size_y == 100
assert prcxi_9300_deck._size_z == 100
def test_prcxi_9320_deck_creation(self, prcxi_9320_deck):
"""测试 PRCXI 9320 工作台创建"""
assert prcxi_9320_deck.name == "PRCXI_Deck_9320"
assert len(prcxi_9320_deck.sites) == 16
assert prcxi_9320_deck._size_x == 100
assert prcxi_9320_deck._size_y == 100
assert prcxi_9320_deck._size_z == 100
def test_container_assignment(self, prcxi_9300_deck, tip_rack_300ul, well_plate_96, trash_container):
"""测试容器分配到工作台"""
# 分配枪头盒
prcxi_9300_deck.assign_child_resource(tip_rack_300ul, location=Coordinate(0, 0, 0))
assert tip_rack_300ul in prcxi_9300_deck.children
# 分配孔板
prcxi_9300_deck.assign_child_resource(well_plate_96, location=Coordinate(0, 0, 0))
assert well_plate_96 in prcxi_9300_deck.children
# 分配垃圾桶
prcxi_9300_deck.assign_child_resource(trash_container, location=Coordinate(0, 0, 0))
assert trash_container in prcxi_9300_deck.children
def test_container_material_loading(self, tip_rack_300ul, well_plate_96, prcxi_materials):
"""测试容器物料信息加载"""
# 测试枪头盒物料信息
tip_material = tip_rack_300ul._unilabos_state["Material"]
assert tip_material["uuid"] == prcxi_materials["300μL Tip头"]["uuid"]
assert tip_material["Name"] == "300μL Tip头"
# 测试孔板物料信息
plate_material = well_plate_96._unilabos_state["Material"]
assert plate_material["uuid"] == prcxi_materials["96深孔板"]["uuid"]
assert plate_material["Name"] == "96深孔板"
class TestPRCXISingleStepOperations:
"""测试 PRCXI 单步操作功能"""
@pytest.mark.asyncio
async def test_pick_up_tips_single_channel(self, prcxi_9320_handler, prcxi_9320_deck, tip_rack_10ul):
"""测试单通道拾取枪头"""
# 将枪头盒添加到工作台
prcxi_9320_deck.assign_child_resource(tip_rack_10ul, location=Coordinate(0, 0, 0))
# 初始化处理器
await prcxi_9320_handler.setup()
# 设置枪头盒
prcxi_9320_handler.set_tiprack([tip_rack_10ul])
# 创建模拟的枪头位置
from pylabrobot.resources import TipSpot, Tip
tip = Tip(has_filter=False, total_tip_length=10, maximal_volume=10, fitting_depth=5)
tip_spot = TipSpot("A1", size_x=1, size_y=1, size_z=1, make_tip=lambda: tip)
tip_rack_10ul.assign_child_resource(tip_spot, location=Coordinate(0, 0, 0))
# 直接测试后端方法
from pylabrobot.liquid_handling import Pickup
pickup = Pickup(resource=tip_spot, offset=None, tip=tip)
await prcxi_9320_handler._unilabos_backend.pick_up_tips([pickup], [0])
# 验证步骤已添加到待办列表
assert len(prcxi_9320_handler._unilabos_backend.steps_todo_list) == 1
step = prcxi_9320_handler._unilabos_backend.steps_todo_list[0]
assert step["Function"] == "Load"
@pytest.mark.asyncio
async def test_pick_up_tips_multi_channel(self, prcxi_9300_handler, tip_rack_300ul):
"""测试多通道拾取枪头"""
# 设置枪头盒
prcxi_9300_handler.set_tiprack([tip_rack_300ul])
# 拾取8个枪头
tip_spots = tip_rack_300ul.children[:8]
await prcxi_9300_handler.pick_up_tips(tip_spots, [0, 1, 2, 3, 4, 5, 6, 7])
# 验证步骤已添加到待办列表
assert len(prcxi_9300_handler._unilabos_backend.steps_todo_list) == 1
step = prcxi_9300_handler._unilabos_backend.steps_todo_list[0]
assert step["Function"] == "Load"
@pytest.mark.asyncio
async def test_aspirate_single_channel(self, prcxi_9320_handler, well_plate_96):
"""测试单通道吸取液体"""
# 设置液体
well = well_plate_96.get_item("A1")
prcxi_9320_handler.set_liquid([well], ["water"], [50])
# 吸取液体
await prcxi_9320_handler.aspirate([well], [50], [0])
# 验证步骤已添加到待办列表
assert len(prcxi_9320_handler._unilabos_backend.steps_todo_list) == 1
step = prcxi_9320_handler._unilabos_backend.steps_todo_list[0]
assert step["Function"] == "Imbibing"
assert step["DosageNum"] == 50
@pytest.mark.asyncio
async def test_dispense_single_channel(self, prcxi_9320_handler, well_plate_96):
"""测试单通道分配液体"""
# 分配液体
well = well_plate_96.get_item("A1")
await prcxi_9320_handler.dispense([well], [25], [0])
# 验证步骤已添加到待办列表
assert len(prcxi_9320_handler._unilabos_backend.steps_todo_list) == 1
step = prcxi_9320_handler._unilabos_backend.steps_todo_list[0]
assert step["Function"] == "Tapping"
assert step["DosageNum"] == 25
@pytest.mark.asyncio
async def test_mix_single_channel(self, prcxi_9320_handler, well_plate_96):
"""测试单通道混合液体"""
# 混合液体
well = well_plate_96.get_item("A1")
await prcxi_9320_handler.mix([well], mix_time=3, mix_vol=50)
# 验证步骤已添加到待办列表
assert len(prcxi_9320_handler._unilabos_backend.steps_todo_list) == 1
step = prcxi_9320_handler._unilabos_backend.steps_todo_list[0]
assert step["Function"] == "Blending"
assert step["BlendingTimes"] == 3
assert step["DosageNum"] == 50
@pytest.mark.asyncio
async def test_drop_tips_to_trash(self, prcxi_9320_handler, trash_container):
"""测试丢弃枪头到垃圾桶"""
# 丢弃枪头
await prcxi_9320_handler.drop_tips([trash_container], [0])
# 验证步骤已添加到待办列表
assert len(prcxi_9320_handler._unilabos_backend.steps_todo_list) == 1
step = prcxi_9320_handler._unilabos_backend.steps_todo_list[0]
assert step["Function"] == "UnLoad"
@pytest.mark.asyncio
async def test_discard_tips(self, prcxi_9320_handler):
"""测试丢弃枪头"""
# 丢弃枪头
await prcxi_9320_handler.discard_tips([0])
# 验证步骤已添加到待办列表
assert len(prcxi_9320_handler._unilabos_backend.steps_todo_list) == 1
step = prcxi_9320_handler._unilabos_backend.steps_todo_list[0]
assert step["Function"] == "UnLoad"
@pytest.mark.asyncio
async def test_liquid_transfer_workflow(self, prcxi_9320_handler, tip_rack_10ul, well_plate_96):
"""测试完整的液体转移工作流程"""
# 设置枪头盒和液体
prcxi_9320_handler.set_tiprack([tip_rack_10ul])
source_well = well_plate_96.get_item("A1")
target_well = well_plate_96.get_item("B1")
prcxi_9320_handler.set_liquid([source_well], ["water"], [100])
# 创建协议
await prcxi_9320_handler.create_protocol(protocol_name="Test Transfer Protocol")
# 执行转移流程
tip_spot = tip_rack_10ul.get_item("A1")
await prcxi_9320_handler.pick_up_tips([tip_spot], [0])
await prcxi_9320_handler.aspirate([source_well], [50], [0])
await prcxi_9320_handler.dispense([target_well], [50], [0])
await prcxi_9320_handler.discard_tips([0])
# 验证所有步骤都已添加
assert len(prcxi_9320_handler._unilabos_backend.steps_todo_list) == 4
functions = [step["Function"] for step in prcxi_9320_handler._unilabos_backend.steps_todo_list]
assert functions == ["Load", "Imbibing", "Tapping", "UnLoad"]
class TestPRCXILayoutRecommendation:
"""测试 PRCXI 板位推荐功能"""
def test_9300_layout_creation(self, default_layout_9300):
"""测试 PRCXI 9300 布局创建"""
layout_info = default_layout_9300.get_layout()
assert layout_info["rows"] == 2
assert layout_info["columns"] == 3
assert len(layout_info["layout"]) == 6
assert layout_info["trash_slot"] == 6
assert "waste_liquid_slot" not in layout_info
def test_9320_layout_creation(self, default_layout_9320):
"""测试 PRCXI 9320 布局创建"""
layout_info = default_layout_9320.get_layout()
assert layout_info["rows"] == 4
assert layout_info["columns"] == 4
assert len(layout_info["layout"]) == 16
assert layout_info["trash_slot"] == 16
assert layout_info["waste_liquid_slot"] == 12
def test_layout_recommendation_9320(self, default_layout_9320, prcxi_materials):
"""测试 PRCXI 9320 板位推荐功能"""
# 添加物料信息
default_layout_9320.add_lab_resource(prcxi_materials)
# 推荐布局
needs = [
("reagent_1", "96 细胞培养皿", 3),
("reagent_2", "12道储液槽", 1),
("reagent_3", "200μL Tip头", 7),
("reagent_4", "10μL加长 Tip头", 1),
]
matrix_layout, layout_list = default_layout_9320.recommend_layout(needs)
# 验证返回结果
assert "MatrixId" in matrix_layout
assert "MatrixName" in matrix_layout
assert "MatrixCount" in matrix_layout
assert "WorkTablets" in matrix_layout
assert len(layout_list) == 12 # 3+1+7+1 = 12个位置
# 验证推荐的位置不包含预留位置
reserved_positions = {12, 16}
recommended_positions = [item["positions"] for item in layout_list]
for pos in recommended_positions:
assert pos not in reserved_positions
def test_layout_recommendation_insufficient_space(self, default_layout_9320, prcxi_materials):
"""测试板位推荐空间不足的情况"""
# 添加物料信息
default_layout_9320.add_lab_resource(prcxi_materials)
# 尝试推荐超过可用空间的布局
needs = [
("reagent_1", "96 细胞培养皿", 15), # 需要15个位置但只有14个可用
]
with pytest.raises(ValueError, match="需要 .* 个位置,但只有 .* 个可用位置"):
default_layout_9320.recommend_layout(needs)
def test_layout_recommendation_material_not_found(self, default_layout_9320, prcxi_materials):
"""测试板位推荐物料不存在的情况"""
# 添加物料信息
default_layout_9320.add_lab_resource(prcxi_materials)
# 尝试推荐不存在的物料
needs = [
("reagent_1", "不存在的物料", 1),
]
with pytest.raises(ValueError, match="Material .* not found in lab resources"):
default_layout_9320.recommend_layout(needs)
class TestPRCXIBackendOperations:
"""测试 PRCXI 后端操作功能"""
def test_backend_initialization(self, prcxi_9300_handler):
"""测试后端初始化"""
backend = prcxi_9300_handler._unilabos_backend
assert isinstance(backend, PRCXI9300Backend)
assert backend._num_channels == 8
assert backend.debug is True
def test_protocol_creation(self, prcxi_9300_handler):
"""测试协议创建"""
backend = prcxi_9300_handler._unilabos_backend
backend.create_protocol("Test Protocol")
assert backend.protocol_name == "Test Protocol"
assert len(backend.steps_todo_list) == 0
def test_channel_validation(self):
"""测试通道验证"""
# 测试正确的8通道配置
valid_channels = [0, 1, 2, 3, 4, 5, 6, 7]
result = PRCXI9300Backend.check_channels(valid_channels)
assert result == valid_channels
# 测试错误的通道配置
invalid_channels = [0, 1, 2, 3]
result = PRCXI9300Backend.check_channels(invalid_channels)
assert result == [0, 1, 2, 3, 4, 5, 6, 7]
def test_matrix_info_creation(self, prcxi_9300_handler):
"""测试矩阵信息创建"""
backend = prcxi_9300_handler._unilabos_backend
backend.create_protocol("Test Protocol")
# 模拟运行协议时的矩阵信息创建
run_time = 1234567890
matrix_info = MatrixInfo(
MatrixId=f"{int(run_time)}",
MatrixName=f"protocol_{run_time}",
MatrixCount=len(backend.tablets_info),
WorkTablets=backend.tablets_info,
)
assert matrix_info["MatrixId"] == str(int(run_time))
assert matrix_info["MatrixName"] == f"protocol_{run_time}"
assert "WorkTablets" in matrix_info
class TestPRCXIContainerOperations:
"""测试 PRCXI 容器操作功能"""
def test_container_serialization(self, tip_rack_300ul):
"""测试容器序列化"""
serialized = tip_rack_300ul.serialize_state()
assert "Material" in serialized
assert serialized["Material"]["Name"] == "300μL Tip头"
def test_container_deserialization(self, tip_rack_300ul):
"""测试容器反序列化"""
# 序列化
serialized = tip_rack_300ul.serialize_state()
# 创建新容器并反序列化
new_tip_rack = PRCXI9300Container(
name="new_tip_rack",
size_x=50,
size_y=50,
size_z=10,
category="tip_rack",
ordering=collections.OrderedDict()
)
new_tip_rack.load_state(serialized)
assert new_tip_rack._unilabos_state["Material"]["Name"] == "300μL Tip头"
def test_trash_container_creation(self, prcxi_materials):
"""测试垃圾桶容器创建"""
trash = PRCXI9300Trash(name="trash", size_x=50, size_y=50, size_z=10, category="trash")
trash.load_state({
"Material": {
"uuid": prcxi_materials["废弃槽"]["uuid"]
}
})
assert trash.name == "trash"
assert trash._unilabos_state["Material"]["uuid"] == prcxi_materials["废弃槽"]["uuid"]
if __name__ == "__main__":
# 运行测试
pytest.main([__file__, "-v"])

View File

@@ -1,15 +0,0 @@
# Liquid handling 集成测试
`test_transfer_liquid.py` 现在会调用 PRCXI 的 RViz 仿真 backend运行前请确保
1. 已安装包含 `pylabrobot``rclpy` 的运行环境;
2. 启动 ROS 依赖(`rviz` 可选,但是 `rviz_backend` 会创建 ROS 节点);
3. 在 shell 中设置 `UNILAB_SIM_TEST=1`,否则 pytest 会自动跳过这些慢速用例:
```bash
export UNILAB_SIM_TEST=1
pytest tests/devices/liquid_handling/test_transfer_liquid.py -m slow
```
如果只需验证逻辑层(不依赖仿真),可以直接运行 `tests/devices/liquid_handling/unit_test.py`,该文件使用 Fake backend适合作为 CI 的快速测试。***

View File

@@ -1,547 +0,0 @@
import asyncio
from dataclasses import dataclass
from typing import Any, Iterable, List, Optional, Sequence, Tuple
import pytest
from unilabos.devices.liquid_handling.liquid_handler_abstract import LiquidHandlerAbstract
@dataclass(frozen=True)
class DummyContainer:
name: str
def __repr__(self) -> str: # pragma: no cover
return f"DummyContainer({self.name})"
@dataclass(frozen=True)
class DummyTipSpot:
name: str
def __repr__(self) -> str: # pragma: no cover
return f"DummyTipSpot({self.name})"
def make_tip_iter(n: int = 256) -> Iterable[List[DummyTipSpot]]:
"""Yield lists so code can safely call `tip.extend(next(self.current_tip))`."""
for i in range(n):
yield [DummyTipSpot(f"tip_{i}")]
class FakeLiquidHandler(LiquidHandlerAbstract):
"""不初始化真实 backend/deck仅用来记录 transfer_liquid 内部调用序列。"""
def __init__(self, channel_num: int = 8):
# 不调用 super().__init__避免真实硬件/后端依赖
self.channel_num = channel_num
self.support_touch_tip = True
self.current_tip = iter(make_tip_iter())
self.calls: List[Tuple[str, Any]] = []
async def pick_up_tips(self, tip_spots, use_channels=None, offsets=None, **backend_kwargs):
self.calls.append(("pick_up_tips", {"tips": list(tip_spots), "use_channels": use_channels}))
async def aspirate(
self,
resources: Sequence[Any],
vols: List[float],
use_channels: Optional[List[int]] = None,
flow_rates: Optional[List[Optional[float]]] = None,
offsets: Any = None,
liquid_height: Any = None,
blow_out_air_volume: Any = None,
spread: str = "wide",
**backend_kwargs,
):
self.calls.append(
(
"aspirate",
{
"resources": list(resources),
"vols": list(vols),
"use_channels": list(use_channels) if use_channels is not None else None,
"flow_rates": list(flow_rates) if flow_rates is not None else None,
"offsets": list(offsets) if offsets is not None else None,
"liquid_height": list(liquid_height) if liquid_height is not None else None,
"blow_out_air_volume": list(blow_out_air_volume) if blow_out_air_volume is not None else None,
},
)
)
async def dispense(
self,
resources: Sequence[Any],
vols: List[float],
use_channels: Optional[List[int]] = None,
flow_rates: Optional[List[Optional[float]]] = None,
offsets: Any = None,
liquid_height: Any = None,
blow_out_air_volume: Any = None,
spread: str = "wide",
**backend_kwargs,
):
self.calls.append(
(
"dispense",
{
"resources": list(resources),
"vols": list(vols),
"use_channels": list(use_channels) if use_channels is not None else None,
"flow_rates": list(flow_rates) if flow_rates is not None else None,
"offsets": list(offsets) if offsets is not None else None,
"liquid_height": list(liquid_height) if liquid_height is not None else None,
"blow_out_air_volume": list(blow_out_air_volume) if blow_out_air_volume is not None else None,
},
)
)
async def discard_tips(self, use_channels=None, *args, **kwargs):
# 有的分支是 discard_tips(use_channels=[0]),有的分支是 discard_tips([0..7])(位置参数)
self.calls.append(("discard_tips", {"use_channels": list(use_channels) if use_channels is not None else None}))
async def custom_delay(self, seconds=0, msg=None):
self.calls.append(("custom_delay", {"seconds": seconds, "msg": msg}))
async def touch_tip(self, targets):
# 原实现会访问 targets.get_size_x() 等;测试里只记录调用
self.calls.append(("touch_tip", {"targets": targets}))
def run(coro):
return asyncio.run(coro)
def test_one_to_one_single_channel_basic_calls():
lh = FakeLiquidHandler(channel_num=1)
lh.current_tip = iter(make_tip_iter(64))
sources = [DummyContainer(f"S{i}") for i in range(3)]
targets = [DummyContainer(f"T{i}") for i in range(3)]
run(
lh.transfer_liquid(
sources=sources,
targets=targets,
tip_racks=[],
use_channels=[0],
asp_vols=[1, 2, 3],
dis_vols=[4, 5, 6],
mix_times=None, # 应该仍能执行(不 mix
)
)
assert [c[0] for c in lh.calls].count("pick_up_tips") == 3
assert [c[0] for c in lh.calls].count("aspirate") == 3
assert [c[0] for c in lh.calls].count("dispense") == 3
assert [c[0] for c in lh.calls].count("discard_tips") == 3
# 每次 aspirate/dispense 都是单孔列表
aspirates = [payload for name, payload in lh.calls if name == "aspirate"]
assert aspirates[0]["resources"] == [sources[0]]
assert aspirates[0]["vols"] == [1.0]
dispenses = [payload for name, payload in lh.calls if name == "dispense"]
assert dispenses[2]["resources"] == [targets[2]]
assert dispenses[2]["vols"] == [6.0]
def test_one_to_one_single_channel_before_stage_mixes_prior_to_aspirate():
lh = FakeLiquidHandler(channel_num=1)
lh.current_tip = iter(make_tip_iter(16))
source = DummyContainer("S0")
target = DummyContainer("T0")
run(
lh.transfer_liquid(
sources=[source],
targets=[target],
tip_racks=[],
use_channels=[0],
asp_vols=[5],
dis_vols=[5],
mix_stage="before",
mix_times=1,
mix_vol=3,
)
)
aspirate_calls = [(idx, payload) for idx, (name, payload) in enumerate(lh.calls) if name == "aspirate"]
assert len(aspirate_calls) >= 2
mix_idx, mix_payload = aspirate_calls[0]
assert mix_payload["resources"] == [target]
assert mix_payload["vols"] == [3]
transfer_idx, transfer_payload = aspirate_calls[1]
assert transfer_payload["resources"] == [source]
assert mix_idx < transfer_idx
def test_one_to_one_eight_channel_groups_by_8():
lh = FakeLiquidHandler(channel_num=8)
lh.current_tip = iter(make_tip_iter(256))
sources = [DummyContainer(f"S{i}") for i in range(16)]
targets = [DummyContainer(f"T{i}") for i in range(16)]
asp_vols = list(range(1, 17))
dis_vols = list(range(101, 117))
run(
lh.transfer_liquid(
sources=sources,
targets=targets,
tip_racks=[],
use_channels=list(range(8)),
asp_vols=asp_vols,
dis_vols=dis_vols,
mix_times=0, # 触发逻辑但不 mix
)
)
# 16 个任务 -> 2 组,每组 8 通道一起做
assert [c[0] for c in lh.calls].count("pick_up_tips") == 2
aspirates = [payload for name, payload in lh.calls if name == "aspirate"]
dispenses = [payload for name, payload in lh.calls if name == "dispense"]
assert len(aspirates) == 2
assert len(dispenses) == 2
assert aspirates[0]["resources"] == sources[0:8]
assert aspirates[0]["vols"] == [float(v) for v in asp_vols[0:8]]
assert dispenses[1]["resources"] == targets[8:16]
assert dispenses[1]["vols"] == [float(v) for v in dis_vols[8:16]]
def test_one_to_one_eight_channel_requires_multiple_of_8_targets():
lh = FakeLiquidHandler(channel_num=8)
lh.current_tip = iter(make_tip_iter(64))
sources = [DummyContainer(f"S{i}") for i in range(9)]
targets = [DummyContainer(f"T{i}") for i in range(9)]
with pytest.raises(ValueError, match="multiple of 8"):
run(
lh.transfer_liquid(
sources=sources,
targets=targets,
tip_racks=[],
use_channels=list(range(8)),
asp_vols=[1] * 9,
dis_vols=[1] * 9,
mix_times=0,
)
)
def test_one_to_one_eight_channel_parameter_lists_are_chunked_per_8():
lh = FakeLiquidHandler(channel_num=8)
lh.current_tip = iter(make_tip_iter(512))
sources = [DummyContainer(f"S{i}") for i in range(16)]
targets = [DummyContainer(f"T{i}") for i in range(16)]
asp_vols = [i + 1 for i in range(16)]
dis_vols = [200 + i for i in range(16)]
asp_flow_rates = [0.1 * (i + 1) for i in range(16)]
dis_flow_rates = [0.2 * (i + 1) for i in range(16)]
offsets = [f"offset_{i}" for i in range(16)]
liquid_heights = [i * 0.5 for i in range(16)]
blow_out_air_volume = [i + 0.05 for i in range(16)]
run(
lh.transfer_liquid(
sources=sources,
targets=targets,
tip_racks=[],
use_channels=list(range(8)),
asp_vols=asp_vols,
dis_vols=dis_vols,
asp_flow_rates=asp_flow_rates,
dis_flow_rates=dis_flow_rates,
offsets=offsets,
liquid_height=liquid_heights,
blow_out_air_volume=blow_out_air_volume,
mix_times=0,
)
)
aspirates = [payload for name, payload in lh.calls if name == "aspirate"]
dispenses = [payload for name, payload in lh.calls if name == "dispense"]
assert len(aspirates) == len(dispenses) == 2
for batch_idx in range(2):
start = batch_idx * 8
end = start + 8
asp_call = aspirates[batch_idx]
dis_call = dispenses[batch_idx]
assert asp_call["resources"] == sources[start:end]
assert asp_call["flow_rates"] == asp_flow_rates[start:end]
assert asp_call["offsets"] == offsets[start:end]
assert asp_call["liquid_height"] == liquid_heights[start:end]
assert asp_call["blow_out_air_volume"] == blow_out_air_volume[start:end]
assert dis_call["flow_rates"] == dis_flow_rates[start:end]
assert dis_call["offsets"] == offsets[start:end]
assert dis_call["liquid_height"] == liquid_heights[start:end]
assert dis_call["blow_out_air_volume"] == blow_out_air_volume[start:end]
def test_one_to_one_eight_channel_handles_32_tasks_four_batches():
lh = FakeLiquidHandler(channel_num=8)
lh.current_tip = iter(make_tip_iter(1024))
sources = [DummyContainer(f"S{i}") for i in range(32)]
targets = [DummyContainer(f"T{i}") for i in range(32)]
asp_vols = [i + 1 for i in range(32)]
dis_vols = [300 + i for i in range(32)]
run(
lh.transfer_liquid(
sources=sources,
targets=targets,
tip_racks=[],
use_channels=list(range(8)),
asp_vols=asp_vols,
dis_vols=dis_vols,
mix_times=0,
)
)
pick_calls = [name for name, _ in lh.calls if name == "pick_up_tips"]
aspirates = [payload for name, payload in lh.calls if name == "aspirate"]
dispenses = [payload for name, payload in lh.calls if name == "dispense"]
assert len(pick_calls) == 4
assert len(aspirates) == len(dispenses) == 4
assert aspirates[0]["resources"] == sources[0:8]
assert aspirates[-1]["resources"] == sources[24:32]
assert dispenses[0]["resources"] == targets[0:8]
assert dispenses[-1]["resources"] == targets[24:32]
def test_one_to_many_single_channel_aspirates_total_when_asp_vol_too_small():
lh = FakeLiquidHandler(channel_num=1)
lh.current_tip = iter(make_tip_iter(64))
source = DummyContainer("SRC")
targets = [DummyContainer(f"T{i}") for i in range(3)]
dis_vols = [10, 20, 30] # sum=60
run(
lh.transfer_liquid(
sources=[source],
targets=targets,
tip_racks=[],
use_channels=[0],
asp_vols=10, # 小于 sum(dis_vols) -> 应吸 60
dis_vols=dis_vols,
mix_times=0,
)
)
aspirates = [payload for name, payload in lh.calls if name == "aspirate"]
assert len(aspirates) == 1
assert aspirates[0]["resources"] == [source]
assert aspirates[0]["vols"] == [60.0]
assert aspirates[0]["use_channels"] == [0]
dispenses = [payload for name, payload in lh.calls if name == "dispense"]
assert [d["vols"][0] for d in dispenses] == [10.0, 20.0, 30.0]
def test_one_to_many_eight_channel_basic():
lh = FakeLiquidHandler(channel_num=8)
lh.current_tip = iter(make_tip_iter(128))
source = DummyContainer("SRC")
targets = [DummyContainer(f"T{i}") for i in range(8)]
dis_vols = [i + 1 for i in range(8)]
run(
lh.transfer_liquid(
sources=[source],
targets=targets,
tip_racks=[],
use_channels=list(range(8)),
asp_vols=999, # one-to-many 8ch 会按 dis_vols 吸(每通道各自)
dis_vols=dis_vols,
mix_times=0,
)
)
aspirates = [payload for name, payload in lh.calls if name == "aspirate"]
assert aspirates[0]["resources"] == [source] * 8
assert aspirates[0]["vols"] == [float(v) for v in dis_vols]
dispenses = [payload for name, payload in lh.calls if name == "dispense"]
assert dispenses[0]["resources"] == targets
assert dispenses[0]["vols"] == [float(v) for v in dis_vols]
def test_many_to_one_single_channel_standard_dispense_equals_asp_by_default():
lh = FakeLiquidHandler(channel_num=1)
lh.current_tip = iter(make_tip_iter(128))
sources = [DummyContainer(f"S{i}") for i in range(3)]
target = DummyContainer("T")
asp_vols = [5, 6, 7]
run(
lh.transfer_liquid(
sources=sources,
targets=[target],
tip_racks=[],
use_channels=[0],
asp_vols=asp_vols,
dis_vols=1, # many-to-one 允许标量;非比例模式下实际每次分液=对应 asp_vol
mix_times=0,
)
)
dispenses = [payload for name, payload in lh.calls if name == "dispense"]
assert [d["vols"][0] for d in dispenses] == [float(v) for v in asp_vols]
assert all(d["resources"] == [target] for d in dispenses)
def test_many_to_one_single_channel_before_stage_mixes_target_once():
lh = FakeLiquidHandler(channel_num=1)
lh.current_tip = iter(make_tip_iter(128))
sources = [DummyContainer("S0"), DummyContainer("S1")]
target = DummyContainer("T")
run(
lh.transfer_liquid(
sources=sources,
targets=[target],
tip_racks=[],
use_channels=[0],
asp_vols=[5, 6],
dis_vols=1,
mix_stage="before",
mix_times=2,
mix_vol=4,
)
)
aspirate_calls = [(idx, payload) for idx, (name, payload) in enumerate(lh.calls) if name == "aspirate"]
assert len(aspirate_calls) >= 1
mix_idx, mix_payload = aspirate_calls[0]
assert mix_payload["resources"] == [target]
assert mix_payload["vols"] == [4]
# 第一個 mix 之後會真正開始吸 source
assert any(call["resources"] == [sources[0]] for _, call in aspirate_calls[1:])
def test_many_to_one_single_channel_proportional_mixing_uses_dis_vols_per_source():
lh = FakeLiquidHandler(channel_num=1)
lh.current_tip = iter(make_tip_iter(128))
sources = [DummyContainer(f"S{i}") for i in range(3)]
target = DummyContainer("T")
asp_vols = [5, 6, 7]
dis_vols = [1, 2, 3]
run(
lh.transfer_liquid(
sources=sources,
targets=[target],
tip_racks=[],
use_channels=[0],
asp_vols=asp_vols,
dis_vols=dis_vols, # 比例模式
mix_times=0,
)
)
dispenses = [payload for name, payload in lh.calls if name == "dispense"]
assert [d["vols"][0] for d in dispenses] == [float(v) for v in dis_vols]
def test_many_to_one_eight_channel_basic():
lh = FakeLiquidHandler(channel_num=8)
lh.current_tip = iter(make_tip_iter(256))
sources = [DummyContainer(f"S{i}") for i in range(8)]
target = DummyContainer("T")
asp_vols = [10 + i for i in range(8)]
run(
lh.transfer_liquid(
sources=sources,
targets=[target],
tip_racks=[],
use_channels=list(range(8)),
asp_vols=asp_vols,
dis_vols=999, # 非比例模式下每通道分液=对应 asp_vol
mix_times=0,
)
)
aspirates = [payload for name, payload in lh.calls if name == "aspirate"]
dispenses = [payload for name, payload in lh.calls if name == "dispense"]
assert aspirates[0]["resources"] == sources
assert aspirates[0]["vols"] == [float(v) for v in asp_vols]
assert dispenses[0]["resources"] == [target] * 8
assert dispenses[0]["vols"] == [float(v) for v in asp_vols]
def test_transfer_liquid_mode_detection_unsupported_shape_raises():
lh = FakeLiquidHandler(channel_num=8)
lh.current_tip = iter(make_tip_iter(64))
sources = [DummyContainer("S0"), DummyContainer("S1")]
targets = [DummyContainer("T0"), DummyContainer("T1"), DummyContainer("T2")]
with pytest.raises(ValueError, match="Unsupported transfer mode"):
run(
lh.transfer_liquid(
sources=sources,
targets=targets,
tip_racks=[],
use_channels=[0],
asp_vols=[1, 1],
dis_vols=[1, 1, 1],
mix_times=0,
)
)
def test_mix_single_target_produces_matching_cycles():
lh = FakeLiquidHandler(channel_num=1)
target = DummyContainer("T_mix")
run(lh.mix(targets=[target], mix_time=2, mix_vol=5))
aspirates = [payload for name, payload in lh.calls if name == "aspirate"]
dispenses = [payload for name, payload in lh.calls if name == "dispense"]
assert len(aspirates) == len(dispenses) == 2
assert all(call["resources"] == [target] for call in aspirates)
assert all(call["vols"] == [5] for call in aspirates)
assert all(call["resources"] == [target] for call in dispenses)
assert all(call["vols"] == [5] for call in dispenses)
def test_mix_multiple_targets_supports_per_target_offsets():
lh = FakeLiquidHandler(channel_num=1)
targets = [DummyContainer("T0"), DummyContainer("T1")]
offsets = ["left", "right"]
heights = [0.1, 0.2]
rates = [0.5, 1.0]
run(
lh.mix(
targets=targets,
mix_time=1,
mix_vol=3,
offsets=offsets,
height_to_bottom=heights,
mix_rate=rates,
)
)
aspirates = [payload for name, payload in lh.calls if name == "aspirate"]
assert len(aspirates) == 2
assert aspirates[0]["resources"] == [targets[0]]
assert aspirates[0]["offsets"] == [offsets[0]]
assert aspirates[0]["liquid_height"] == [heights[0]]
assert aspirates[0]["flow_rates"] == [rates[0]]
assert aspirates[1]["resources"] == [targets[1]]
assert aspirates[1]["offsets"] == [offsets[1]]
assert aspirates[1]["liquid_height"] == [heights[1]]
assert aspirates[1]["flow_rates"] == [rates[1]]

6
unilabos/__main__.py Normal file
View File

@@ -0,0 +1,6 @@
"""Entry point for `python -m unilabos`."""
from unilabos.app.main import main
if __name__ == "__main__":
main()

View File

@@ -80,19 +80,20 @@ class HTTPClient:
f.write(json.dumps(payload, indent=4))
# 从序列化数据中提取所有节点的UUID保存旧UUID
old_uuids = {n.res_content.uuid: n for n in resources.all_nodes}
nodes_info = [x for xs in resources.dump() for x in xs]
if not self.initialized or first_add:
self.initialized = True
info(f"首次添加资源,当前远程地址: {self.remote_addr}")
response = requests.post(
f"{self.remote_addr}/edge/material",
json={"nodes": [x for xs in resources.dump() for x in xs], "mount_uuid": mount_uuid},
json={"nodes": nodes_info, "mount_uuid": mount_uuid},
headers={"Authorization": f"Lab {self.auth}"},
timeout=60,
)
else:
response = requests.put(
f"{self.remote_addr}/edge/material",
json={"nodes": [x for xs in resources.dump() for x in xs], "mount_uuid": mount_uuid},
json={"nodes": nodes_info, "mount_uuid": mount_uuid},
headers={"Authorization": f"Lab {self.auth}"},
timeout=10,
)
@@ -111,6 +112,7 @@ class HTTPClient:
uuid_mapping[i["uuid"]] = i["cloud_uuid"]
else:
logger.error(f"添加物料失败: {response.text}")
logger.trace(f"添加物料失败: {nodes_info}")
for u, n in old_uuids.items():
if u in uuid_mapping:
n.res_content.uuid = uuid_mapping[u]

View File

@@ -58,14 +58,14 @@ class JobResultStore:
feedback=feedback or {},
timestamp=time.time(),
)
logger.debug(f"[JobResultStore] Stored result for job {job_id[:8]}, status={status}")
logger.trace(f"[JobResultStore] Stored result for job {job_id[:8]}, status={status}")
def get_and_remove(self, job_id: str) -> Optional[JobResult]:
"""获取并删除任务结果"""
with self._results_lock:
result = self._results.pop(job_id, None)
if result:
logger.debug(f"[JobResultStore] Retrieved and removed result for job {job_id[:8]}")
logger.trace(f"[JobResultStore] Retrieved and removed result for job {job_id[:8]}")
return result
def get_result(self, job_id: str) -> Optional[JobResult]:

View File

@@ -1113,7 +1113,7 @@ class MessageProcessor:
"task_id": task_id,
"job_id": job_id,
"free": free,
"need_more": need_more,
"need_more": need_more + 1,
},
}
@@ -1253,7 +1253,7 @@ class QueueProcessor:
"task_id": job_info.task_id,
"job_id": job_info.job_id,
"free": False,
"need_more": 10,
"need_more": 10 + 1,
},
}
self.message_processor.send_message(message)
@@ -1286,7 +1286,7 @@ class QueueProcessor:
"task_id": job_info.task_id,
"job_id": job_info.job_id,
"free": False,
"need_more": 10,
"need_more": 10 + 1,
},
}
success = self.message_processor.send_message(message)
@@ -1369,6 +1369,10 @@ class WebSocketClient(BaseCommunicationClient):
self.message_processor = MessageProcessor(self.websocket_url, self.send_queue, self.device_manager)
self.queue_processor = QueueProcessor(self.device_manager, self.message_processor)
# running状态debounce缓存: {job_id: (last_send_timestamp, last_feedback_data)}
self._job_running_last_sent: Dict[str, tuple] = {}
self._job_running_debounce_interval: float = 10.0 # 秒
# 设置相互引用
self.message_processor.set_queue_processor(self.queue_processor)
self.message_processor.set_websocket_client(self)
@@ -1468,22 +1472,32 @@ class WebSocketClient(BaseCommunicationClient):
logger.debug(f"[WebSocketClient] Not connected, cannot publish job status for job_id: {item.job_id}")
return
job_log = format_job_log(item.job_id, item.task_id, item.device_id, item.action_name)
# 拦截最终结果状态,与原版本逻辑一致
if status in ["success", "failed"]:
self._job_running_last_sent.pop(item.job_id, None)
host_node = HostNode.get_instance(0)
if host_node:
# 从HostNode的device_action_status中移除job_id
try:
host_node._device_action_status[item.device_action_key].job_ids.pop(item.job_id, None)
except (KeyError, AttributeError):
logger.warning(f"[WebSocketClient] Failed to remove job {item.job_id} from HostNode status")
# logger.debug(f"[WebSocketClient] Intercepting final status for job_id: {item.job_id} - {status}")
# 通知队列处理器job完成包括timeout的job
self.queue_processor.handle_job_completed(item.job_id, status)
# 发送job状态消息
# running状态按job_id做debounce内容变化时仍然上报
if status == "running":
now = time.time()
cached = self._job_running_last_sent.get(item.job_id)
if cached is not None:
last_ts, last_data = cached
if now - last_ts < self._job_running_debounce_interval and last_data == feedback_data:
logger.trace(f"[WebSocketClient] Job status debounced (skip): {job_log} - {status}")
return
self._job_running_last_sent[item.job_id] = (now, feedback_data)
message = {
"action": "job_status",
"data": {
@@ -1499,7 +1513,6 @@ class WebSocketClient(BaseCommunicationClient):
}
self.message_processor.send_message(message)
job_log = format_job_log(item.job_id, item.task_id, item.device_id, item.action_name)
logger.trace(f"[WebSocketClient] Job status published: {job_log} - {status}")
def send_ping(self, ping_id: str, timestamp: float) -> None:

File diff suppressed because it is too large Load Diff

View File

@@ -43,7 +43,7 @@ class Base(ABC):
self._type = typ
self._data_type = data_type
self._node: Optional[Node] = None
def _get_node(self) -> Node:
if self._node is None:
try:
@@ -66,7 +66,7 @@ class Base(ABC):
# 直接以字符串形式处理
if isinstance(nid, str):
nid = nid.strip()
# 处理包含类名的格式,如 'StringNodeId(ns=4;s=...)' 或 'NumericNodeId(ns=2;i=...)'
# 提取括号内的内容
match_wrapped = re.match(r'(String|Numeric|Byte|Guid|TwoByteNode|FourByteNode)NodeId\((.*)\)', nid)
@@ -116,16 +116,16 @@ class Base(ABC):
def read(self) -> Tuple[Any, bool]:
"""读取节点值,返回(值, 是否出错)"""
pass
@abstractmethod
def write(self, value: Any) -> bool:
"""写入节点值,返回是否出错"""
pass
@property
def type(self) -> NodeType:
return self._type
@property
def node_id(self) -> str:
return self._node_id
@@ -210,15 +210,15 @@ class Method(Base):
super().__init__(client, name, node_id, NodeType.METHOD, data_type)
self._parent_node_id = parent_node_id
self._parent_node = None
def _get_parent_node(self) -> Node:
if self._parent_node is None:
try:
# 处理父节点ID使用与_get_node相同的解析逻辑
import re
nid = self._parent_node_id
# 如果已经是 NodeId 对象,直接使用
try:
from opcua.ua import NodeId as UaNodeId
@@ -227,16 +227,16 @@ class Method(Base):
return self._parent_node
except Exception:
pass
# 字符串处理
if isinstance(nid, str):
nid = nid.strip()
# 处理包含类名的格式
match_wrapped = re.match(r'(String|Numeric|Byte|Guid|TwoByteNode|FourByteNode)NodeId\((.*)\)', nid)
if match_wrapped:
nid = match_wrapped.group(2).strip()
# 常见短格式
if re.match(r'^ns=\d+;[is]=', nid):
self._parent_node = self._client.get_node(nid)
@@ -271,7 +271,7 @@ class Method(Base):
def write(self, value: Any) -> bool:
"""方法节点不支持写入操作"""
return True
def call(self, *args) -> Tuple[Any, bool]:
"""调用方法,返回(返回值, 是否出错)"""
try:
@@ -285,7 +285,7 @@ class Method(Base):
class Object(Base):
def __init__(self, client: Client, name: str, node_id: str):
super().__init__(client, name, node_id, NodeType.OBJECT, None)
def read(self) -> Tuple[Any, bool]:
"""对象节点不支持直接读取操作"""
return None, True
@@ -293,7 +293,7 @@ class Object(Base):
def write(self, value: Any) -> bool:
"""对象节点不支持直接写入操作"""
return True
def get_children(self) -> Tuple[List[Node], bool]:
"""获取子节点列表,返回(子节点列表, 是否出错)"""
try:
@@ -301,4 +301,4 @@ class Object(Base):
return children, False
except Exception as e:
print(f"获取对象 {self._name} 的子节点失败: {e}")
return [], True
return [], True

View File

@@ -201,42 +201,17 @@ class ResourceVisualization:
self.moveit_controllers_yaml['moveit_simple_controller_manager'][f"{name}_{controller_name}"] = moveit_dict['moveit_simple_controller_manager'][controller_name]
@staticmethod
def _ensure_ros2_env() -> dict:
"""确保 ROS2 环境变量正确设置,返回可用于子进程的 env dict"""
import sys
env = dict(os.environ)
conda_prefix = os.path.dirname(os.path.dirname(sys.executable))
if "AMENT_PREFIX_PATH" not in env or not env["AMENT_PREFIX_PATH"].strip():
candidate = os.pathsep.join([conda_prefix, os.path.join(conda_prefix, "Library")])
env["AMENT_PREFIX_PATH"] = candidate
os.environ["AMENT_PREFIX_PATH"] = candidate
extra_bin_dirs = [
os.path.join(conda_prefix, "Library", "bin"),
os.path.join(conda_prefix, "Library", "lib"),
os.path.join(conda_prefix, "Scripts"),
conda_prefix,
]
current_path = env.get("PATH", "")
for d in extra_bin_dirs:
if d not in current_path:
current_path = d + os.pathsep + current_path
env["PATH"] = current_path
os.environ["PATH"] = current_path
return env
def create_launch_description(self) -> LaunchDescription:
"""
创建launch描述包含robot_state_publisher和move_group节点
Args:
urdf_str: URDF文本
Returns:
LaunchDescription: launch描述对象
"""
launch_env = self._ensure_ros2_env()
# 检查ROS 2环境变量
if "AMENT_PREFIX_PATH" not in os.environ:
raise OSError(
"ROS 2环境未正确设置。需要设置 AMENT_PREFIX_PATH 环境变量。\n"
@@ -315,7 +290,7 @@ class ResourceVisualization:
{"robot_description": robot_description},
ros2_controllers,
],
env=launch_env,
env=dict(os.environ)
)
)
for controller in self.moveit_controllers_yaml['moveit_simple_controller_manager']['controller_names']:
@@ -325,7 +300,7 @@ class ResourceVisualization:
executable="spawner",
arguments=[f"{controller}", "--controller-manager", f"controller_manager"],
output="screen",
env=launch_env,
env=dict(os.environ)
)
)
controllers.append(
@@ -334,7 +309,7 @@ class ResourceVisualization:
executable="spawner",
arguments=["joint_state_broadcaster", "--controller-manager", f"controller_manager"],
output="screen",
env=launch_env,
env=dict(os.environ)
)
)
for i in controllers:
@@ -342,6 +317,7 @@ class ResourceVisualization:
else:
ros2_controllers = None
# 创建robot_state_publisher节点
robot_state_publisher = nd(
package='robot_state_publisher',
executable='robot_state_publisher',
@@ -351,8 +327,9 @@ class ResourceVisualization:
'robot_description': robot_description,
'use_sim_time': False
},
# kinematics_dict
],
env=launch_env,
env=dict(os.environ)
)
@@ -384,7 +361,7 @@ class ResourceVisualization:
executable='move_group',
output='screen',
parameters=moveit_params,
env=launch_env,
env=dict(os.environ)
)
@@ -402,11 +379,13 @@ class ResourceVisualization:
arguments=['-d', f"{str(self.mesh_path)}/view_robot.rviz"],
output='screen',
parameters=[
{'robot_description_kinematics': kinematics_dict},
{'robot_description_kinematics': kinematics_dict,
},
robot_description_planning,
planning_pipelines,
],
env=launch_env,
env=dict(os.environ)
)
self.launch_description.add_action(rviz_node)

File diff suppressed because it is too large Load Diff

View File

@@ -45,7 +45,6 @@ from pylabrobot.resources import (
Trash,
PlateAdapter,
TubeRack,
create_homogeneous_resources,
)
from unilabos.devices.liquid_handling.liquid_handler_abstract import (
@@ -56,7 +55,6 @@ from unilabos.devices.liquid_handling.liquid_handler_abstract import (
TransferLiquidReturn,
)
from unilabos.registry.placeholder_type import ResourceSlot
from unilabos.resources.itemized_carrier import ItemizedCarrier
from unilabos.resources.resource_tracker import ResourceTreeSet
from unilabos.ros.nodes.base_device_node import BaseROS2DeviceNode
@@ -87,46 +85,25 @@ class MatrixInfo(TypedDict):
WorkTablets: list[WorkTablets]
def _get_slot_number(resource) -> Optional[int]:
"""从 resource 的 unilabos_extra["update_resource_site"](如 "T13")或位置反算槽位号。"""
extra = getattr(resource, "unilabos_extra", {}) or {}
site = extra.get("update_resource_site", "")
if site:
digits = "".join(c for c in str(site) if c.isdigit())
return int(digits) if digits else None
loc = getattr(resource, "location", None)
if loc is not None and loc.x is not None and loc.y is not None:
col = round((loc.x - 5) / 137.5)
row = round(3 - (loc.y - 13) / 96)
idx = row * 4 + col
if 0 <= idx < 16:
return idx + 1
return None
class PRCXI9300Deck(Deck):
"""PRCXI 9300 的专用 Deck 类,继承自 Deck。
该类定义了 PRCXI 9300 的工作台布局和槽位信息。
"""
_9320_SITE_POSITIONS = [((i%4)*137.5+5, (3-int(i/4))*96+13, 0) for i in range(0, 16)]
# 9300: 3列×2行 = 6 slots间距与9320相同X: 138mm, Y: 96mm
_9300_SITE_POSITIONS = [
(0, 96, 0), (138, 96, 0), (276, 96, 0), # T1-T3 (第1行, 上)
(0, 0, 0), (138, 0, 0), (276, 0, 0), # T4-T6 (第2行, 下)
# T1-T16 默认位置 (4列×4行)
_DEFAULT_SITE_POSITIONS = [
(0, 0, 0), (138, 0, 0), (276, 0, 0), (414, 0, 0), # T1-T4
(0, 96, 0), (138, 96, 0), (276, 96, 0), (414, 96, 0), # T5-T8
(0, 192, 0), (138, 192, 0), (276, 192, 0), (414, 192, 0), # T9-T12
(0, 288, 0), (138, 288, 0), (276, 288, 0), (414, 288, 0), # T13-T16
]
# 向后兼容别名
_DEFAULT_SITE_POSITIONS = _9320_SITE_POSITIONS
_DEFAULT_SITE_SIZE = {"width": 128.0, "height": 86, "depth": 0}
_DEFAULT_CONTENT_TYPE = ["plate", "tip_rack", "plates", "tip_racks", "tube_rack", "adaptor", "plateadapter", "module", "trash"]
_DEFAULT_CONTENT_TYPE = ["plate", "tip_rack", "plates", "tip_racks", "tube_rack", "adaptor"]
def __init__(self, name: str, size_x: float, size_y: float, size_z: float,
sites: Optional[List[Dict[str, Any]]] = None, **kwargs):
super().__init__( size_x, size_y, size_z, name=name)
super().__init__(size_x, size_y, size_z, name)
if sites is not None:
self.sites: List[Dict[str, Any]] = [dict(s) for s in sites]
else:
@@ -143,7 +120,6 @@ class PRCXI9300Deck(Deck):
self._ordering = collections.OrderedDict(
(site["label"], None) for site in self.sites
)
self.root = self.get_root()
def _get_site_location(self, idx: int) -> Coordinate:
pos = self.sites[idx]["position"]
@@ -186,10 +162,7 @@ class PRCXI9300Deck(Deck):
raise ValueError(f"No available site on deck '{self.name}' for resource '{resource.name}'")
if not reassign and self._get_site_resource(idx) is not None:
existing = self.root.get_resource(resource.name)
if existing is not resource and existing.parent is not None:
existing.parent.unassign_child_resource(existing)
raise ValueError(f"Site {idx} ('{self.sites[idx]['label']}') is already occupied")
loc = self._get_site_location(idx)
super().assign_child_resource(resource, location=loc, reassign=reassign)
@@ -199,7 +172,6 @@ class PRCXI9300Deck(Deck):
def serialize(self) -> dict:
data = super().serialize()
data["model"] = self.model
sites_out = []
for i, site in enumerate(self.sites):
occupied = self._get_site_resource(i)
@@ -572,108 +544,6 @@ class PRCXI9300TubeRack(TubeRack):
return data
class PRCXI9300ModuleSite(ItemizedCarrier):
"""
PRCXI 功能模块的基础站点类(加热/冷却/震荡/磁吸等)。
- 继承 ItemizedCarrier可被拖放到 Deck 槽位上
- 顶面有一个 ResourceHolder 站点,可吸附板类资源(叠放)
- content_type 包含 "plateadapter" 以支持适配器叠放
- 支持 material_info 注入
"""
def __init__(self, name: str, size_x: float, size_y: float, size_z: float,
material_info: Optional[Dict[str, Any]] = None, **kwargs):
sites = create_homogeneous_resources(
klass=ResourceHolder,
locations=[Coordinate(0, 0, 0)],
resource_size_x=size_x,
resource_size_y=size_y,
resource_size_z=size_z,
name_prefix=name,
)[0]
kwargs.pop('layout', None)
sites_in = kwargs.pop('sites', None)
sites_dict = {name: sites}
content_type = [
"plate",
"tip_rack",
"plates",
"tip_racks",
"tube_rack",
"plateadapter",
]
if sites_in is not None and isinstance(sites_in, dict):
for site_key, site_value in sites_in.items():
if site_key in sites_dict:
sites_dict[site_key] = site_value
super().__init__(
name, size_x, size_y, size_z,
sites=sites_dict,
num_items_x=kwargs.pop('num_items_x', 1),
num_items_y=kwargs.pop('num_items_y', 1),
num_items_z=kwargs.pop('num_items_z', 1),
content_type=content_type,
**kwargs,
)
self._unilabos_state = {}
if material_info:
self._unilabos_state["Material"] = material_info
def assign_child_resource(self, resource, location=Coordinate(0, 0, 0), reassign=True, spot=None):
from pylabrobot.resources.resource import Resource
Resource.assign_child_resource(self, resource, location=location, reassign=reassign)
def unassign_child_resource(self, resource):
from pylabrobot.resources.resource import Resource
Resource.unassign_child_resource(self, resource)
def serialize_state(self) -> Dict[str, Dict[str, Any]]:
try:
data = super().serialize_state()
except AttributeError:
data = {}
if hasattr(self, 'sites') and self.sites:
sites_info = []
for site in self.sites:
if hasattr(site, '__class__') and 'pylabrobot' in str(site.__class__.__module__):
sites_info.append({
"__pylabrobot_object__": True,
"class": site.__class__.__name__,
"module": site.__class__.__module__,
"name": getattr(site, 'name', str(site))
})
else:
sites_info.append(site)
data['sites'] = sites_info
if hasattr(self, "_unilabos_state") and self._unilabos_state:
safe_state: Dict[str, Any] = {}
for k, v in self._unilabos_state.items():
if k == "Material" and isinstance(v, dict):
safe_material: Dict[str, Any] = {}
for mk, mv in v.items():
if isinstance(mv, (str, int, float, bool, list, dict, type(None))):
safe_material[mk] = mv
safe_state[k] = safe_material
elif isinstance(v, (str, int, float, bool, list, dict, type(None))):
safe_state[k] = v
data.update(safe_state)
return data
def load_state(self, state: Dict[str, Any]) -> None:
super().load_state(state)
if 'sites' in state:
self.sites = [state['sites']]
class PRCXI9300PlateAdapter(PlateAdapter):
"""
专用板式适配器类:用于承载 Plate 的底座(如 PCR 适配器、磁吸架等)。
@@ -776,48 +646,20 @@ class PRCXI9300Handler(LiquidHandlerAbstract):
step_mode=False,
matrix_id="",
is_9320=False,
start_rail=2,
rail_nums=4,
rail_interval=0,
x_increase = -0.003636,
y_increase = -0.003636,
x_offset = 9.2,
y_offset = -27.98,
deck_z = 300,
deck_y = 400,
rail_width=27.5,
xy_coupling = -0.0045,
):
self.deck_x = (start_rail + rail_nums*5 + (rail_nums-1)*rail_interval) * rail_width
self.deck_y = deck_y
self.deck_z = deck_z
self.x_increase = x_increase
self.y_increase = y_increase
self.x_offset = x_offset
self.y_offset = y_offset
self.xy_coupling = xy_coupling
self.left_2_claw = Coordinate(-130.2, 34, -134)
self.right_2_left = Coordinate(22,-1, 8)
plate_positions = []
tablets_info = []
if is_9320 is None:
is_9320 = getattr(deck, 'model', '9300') == '9320'
for site_id in range(len(deck.sites)):
child = deck._get_site_resource(site_id)
# 如果放其他类型的物料,是不可以的
if hasattr(child, "_unilabos_state") and "Material" in child._unilabos_state:
number = site_id + 1
tablets_info.append(
WorkTablets(
Number=number, Code=f"T{number}", Material=child._unilabos_state["Material"]
)
)
if is_9320:
print("当前设备是9320")
else:
for site_id in range(len(deck.sites)):
child = deck._get_site_resource(site_id)
# 如果放其他类型的物料,是不可以的
if hasattr(child, "_unilabos_state") and "Material" in child._unilabos_state:
number = site_id + 1
tablets_info.append(
WorkTablets(
Number=number, Code=f"T{number}", Material=child._unilabos_state["Material"]
)
)
# 始终初始化 step_mode 属性
self.step_mode = False
if step_mode:
@@ -829,190 +671,6 @@ class PRCXI9300Handler(LiquidHandlerAbstract):
tablets_info, host, port, timeout, channel_num, axis, setup, debug, matrix_id, is_9320
)
super().__init__(backend=self._unilabos_backend, deck=deck, simulator=simulator, channel_num=channel_num)
self._first_transfer_done = False
@staticmethod
def _get_slot_number(resource) -> Optional[int]:
"""从 resource 的 unilabos_extra["update_resource_site"](如 "T13")或位置反算槽位号。"""
return _get_slot_number(resource)
def _match_and_create_matrix(self):
"""首次 transfer_liquid 时,根据 deck 上的 resource 自动匹配耗材并创建 WorkTabletMatrix。"""
backend = self._unilabos_backend
api = backend.api_client
if backend.matrix_id:
return
material_list = api.get_all_materials()
if not material_list:
return
# 按 materialEnum 分组: {enum_value: [material, ...]}
material_dict = {}
material_uuid_map = {}
for m in material_list:
enum_key = m.get("materialEnum")
material_dict.setdefault(enum_key, []).append(m)
if "uuid" in m:
material_uuid_map[m["uuid"]] = m
work_tablets = []
slot_none = [i for i in range(1, 17)]
for child in self.deck.children:
resource = child
number = self._get_slot_number(resource)
if number is None:
continue
# 如果 resource 已有 Material UUID直接使用
if hasattr(resource, "_unilabos_state") and "Material" in getattr(resource, "_unilabos_state", {}):
mat_uuid = resource._unilabos_state["Material"].get("uuid")
if mat_uuid and mat_uuid in material_uuid_map:
work_tablets.append({"Number": number, "Material": material_uuid_map[mat_uuid]})
continue
# 根据 resource 类型推断 materialEnum
# MaterialEnum: Other=0, Tips=1, DeepWellPlate=2, PCRPlate=3, ELISAPlate=4, Reservoir=5, WasteBox=6
expected_enum = None
if isinstance(resource, PRCXI9300TipRack) or isinstance(resource, TipRack):
expected_enum = 1 # Tips
elif isinstance(resource, PRCXI9300Trash) or isinstance(resource, Trash):
expected_enum = 6 # WasteBox
elif isinstance(resource, (PRCXI9300Plate, Plate)):
expected_enum = None # Plate 可能是 DeepWellPlate/PCRPlate/ELISAPlate不限定
# 根据 expected_enum 筛选候选耗材列表
if expected_enum is not None:
candidates = material_dict.get(expected_enum, [])
else:
# expected_enum 未确定时,搜索所有耗材
candidates = material_list
# 根据 children 个数和容量匹配最相似的耗材
num_children = len(resource.children)
child_max_volume = None
if resource.children:
first_child = resource.children[0]
if hasattr(first_child, "max_volume") and first_child.max_volume is not None:
child_max_volume = first_child.max_volume
best_material = None
best_score = float("inf")
for material in candidates:
hole_count = (material.get("HoleRow", 0) or 0) * (material.get("HoleColum", 0) or 0)
material_volume = material.get("Volume", 0) or 0
# 孔数差异(高权重优先匹配孔数)
hole_diff = abs(num_children - hole_count)
# 容量差异(归一化)
if child_max_volume is not None and material_volume > 0:
vol_diff = abs(child_max_volume - material_volume) / material_volume
else:
vol_diff = 0
score = hole_diff * 1000 + vol_diff
if score < best_score:
best_score = score
best_material = material
if best_material:
work_tablets.append({"Number": number, "Material": best_material})
slot_none.remove(number)
if not work_tablets:
return
matrix_id = str(uuid.uuid4())
matrix_info = {
"MatrixId": matrix_id,
"MatrixName": matrix_id,
"WorkTablets": work_tablets +
[{"Number": number, "Material": {"uuid": "730067cf07ae43849ddf4034299030e9"}} for number in slot_none],
}
res = api.add_WorkTablet_Matrix(matrix_info)
if res.get("Success"):
backend.matrix_id = matrix_id
backend.matrix_info = matrix_info
# 重新计算所有槽位的位置(初始化时 deck 可能为空,此时才有资源)
pipetting_positions = []
plate_positions = []
for child in self.deck.children:
number = self._get_slot_number(child)
if number is None:
continue
pos = self.plr_pos_to_prcxi(child)
plate_positions.append({"Number": number, "XPos": pos.x, "YPos": pos.y, "ZPos": pos.z})
if child.children:
pip_pos = self.plr_pos_to_prcxi(child.children[0], self.left_2_claw)
else:
pip_pos = self.plr_pos_to_prcxi(child, Coordinate(-100, self.left_2_claw.y, self.left_2_claw.z))
half_x = child.get_size_x() / 2 * abs(1 + self.x_increase)
z_wall = child.get_size_z()
pipetting_positions.append({
"Number": number,
"XPos": pip_pos.x,
"YPos": pip_pos.y,
"ZPos": pip_pos.z,
"X_Left": half_x,
"X_Right": half_x,
"ZAgainstTheWall": pip_pos.z - z_wall,
"X2Pos": pip_pos.x + self.right_2_left.x,
"Y2Pos": pip_pos.y + self.right_2_left.y,
"Z2Pos": pip_pos.z + self.right_2_left.z,
"X2_Left": half_x,
"X2_Right": half_x,
"ZAgainstTheWall2": pip_pos.z - z_wall,
})
if pipetting_positions:
api.update_pipetting_position(matrix_id, pipetting_positions)
# 更新 backend 中的 plate_positions
backend.plate_positions = plate_positions
if plate_positions:
api.update_clamp_jaw_position(matrix_id, plate_positions)
print(f"Auto-matched materials and created matrix: {matrix_id}")
else:
raise PRCXIError(f"Failed to create auto-matched matrix: {res.get('Message', 'Unknown error')}")
def plr_pos_to_prcxi(self, resource: Resource, offset: Coordinate = Coordinate(0, 0, 0)):
z_pos = 'c'
if isinstance(resource, Tip):
z_pos = 'b'
resource_pos = resource.get_absolute_location(x="c",y="c",z=z_pos)
x = resource_pos.x
y = resource_pos.y
z = resource_pos.z
# 如果z等于0则递归resource.parent的高度并向z加使用get_size_z方法
parent = resource.parent
res_z = resource.location.z
while not isinstance(parent, LiquidHandlerAbstract) and (res_z == 0) and parent is not None:
z += parent.get_size_z()
res_z = parent.location.z
parent = getattr(parent, "parent", None)
prcxi_x = (self.deck_x - x)*(1+self.x_increase) + self.x_offset + self.xy_coupling * (self.deck_y - y)
prcxi_y = (self.deck_y - y)*(1+self.y_increase) + self.y_offset
prcxi_z = self.deck_z - z
prcxi_x = min(max(0, prcxi_x+offset.x),self.deck_x)
prcxi_y = min(max(0, prcxi_y+offset.y),self.deck_y)
prcxi_z = min(max(0, prcxi_z+offset.z),self.deck_z)
return Coordinate(prcxi_x, prcxi_y, prcxi_z)
def post_init(self, ros_node: BaseROS2DeviceNode):
super().post_init(ros_node)
@@ -1044,8 +702,8 @@ class PRCXI9300Handler(LiquidHandlerAbstract):
):
self._unilabos_backend.create_protocol(protocol_name)
async def run_protocol(self, protocol_id: str = None):
return self._unilabos_backend.run_protocol(protocol_id)
async def run_protocol(self):
return self._unilabos_backend.run_protocol()
async def remove_liquid(
self,
@@ -1136,7 +794,6 @@ class PRCXI9300Handler(LiquidHandlerAbstract):
touch_tip: bool = False,
liquid_height: Optional[List[Optional[float]]] = None,
blow_out_air_volume: Optional[List[Optional[float]]] = None,
blow_out_air_volume_before: Optional[List[Optional[float]]] = None,
spread: Literal["wide", "tight", "custom"] = "wide",
is_96_well: bool = False,
mix_stage: Optional[Literal["none", "before", "after", "both"]] = "none",
@@ -1147,12 +804,7 @@ class PRCXI9300Handler(LiquidHandlerAbstract):
delays: Optional[List[int]] = None,
none_keys: List[str] = [],
) -> TransferLiquidReturn:
if not self._first_transfer_done:
self._match_and_create_matrix()
self._first_transfer_done = True
if self.step_mode:
await self.create_protocol(f"transfer_liquid{time.time()}")
res = await super().transfer_liquid(
return await super().transfer_liquid(
sources,
targets,
tip_racks,
@@ -1165,7 +817,6 @@ class PRCXI9300Handler(LiquidHandlerAbstract):
touch_tip=touch_tip,
liquid_height=liquid_height,
blow_out_air_volume=blow_out_air_volume,
blow_out_air_volume_before=blow_out_air_volume_before,
spread=spread,
is_96_well=is_96_well,
mix_stage=mix_stage,
@@ -1176,9 +827,6 @@ class PRCXI9300Handler(LiquidHandlerAbstract):
delays=delays,
none_keys=none_keys,
)
if self.step_mode:
await self.run_protocol()
return res
async def custom_delay(self, seconds=0, msg=None):
return await super().custom_delay(seconds, msg)
@@ -1195,10 +843,9 @@ class PRCXI9300Handler(LiquidHandlerAbstract):
offsets: Optional[Coordinate] = None,
mix_rate: Optional[float] = None,
none_keys: List[str] = [],
use_channels: Optional[List[int]] = [0],
):
return await self._unilabos_backend.mix(
targets, mix_time, mix_vol, height_to_bottom, offsets, mix_rate, none_keys, use_channels
targets, mix_time, mix_vol, height_to_bottom, offsets, mix_rate, none_keys
)
def iter_tips(self, tip_racks: Sequence[TipRack]) -> Iterator[Resource]:
@@ -1211,6 +858,10 @@ class PRCXI9300Handler(LiquidHandlerAbstract):
offsets: Optional[List[Coordinate]] = None,
**backend_kwargs,
):
if self.step_mode:
await self.create_protocol(f"单点动作{time.time()}")
await super().pick_up_tips(tip_spots, use_channels, offsets, **backend_kwargs)
await self.run_protocol()
return await super().pick_up_tips(tip_spots, use_channels, offsets, **backend_kwargs)
async def aspirate(
@@ -1362,24 +1013,6 @@ class PRCXI9300Backend(LiquidHandlerBackend):
self.debug = debug
self.axis = "Left"
@staticmethod
def _deck_plate_slot_no(plate, deck) -> int:
"""台面板位槽号116与 PRCXI9300Handler._get_slot_number 一致;无法解析时退回 deck 子项顺序 +1。"""
sn = PRCXI9300Handler._get_slot_number(plate)
if sn is not None:
return sn
return deck.children.index(plate) + 1
@staticmethod
def _resource_num_items_y(resource) -> int:
"""板/TipRack 等在 Y 向孔位数;无 ``num_items_y`` 或非正数时返回 1。"""
ny = getattr(resource, "num_items_y", None)
try:
n = int(ny) if ny is not None else 1
except (TypeError, ValueError):
n = 1
return n if n >= 1 else 1
async def shaker_action(self, time: int, module_no: int, amplitude: int, is_wait: bool):
step = self.api_client.shaker_action(
time=time,
@@ -1431,40 +1064,26 @@ class PRCXI9300Backend(LiquidHandlerBackend):
self.protocol_name = protocol_name
self.steps_todo_list = []
if not len(self.matrix_id):
self.matrix_id = str(uuid.uuid4())
material_list = self.api_client.get_all_materials()
material_dict = {material["uuid"]: material for material in material_list}
work_tablets = []
for num, material_id in self.tablets_info.items():
work_tablets.append({
"Number": num,
"Material": material_dict[material_id]
})
self.matrix_info = {
"MatrixId": self.matrix_id,
"MatrixName": self.matrix_id,
"WorkTablets": work_tablets,
}
# print(json.dumps(self.matrix_info, indent=2))
res = self.api_client.add_WorkTablet_Matrix(self.matrix_info)
if not res["Success"]:
self.matrix_id = ""
raise AssertionError(f"Failed to create matrix: {res.get('Message', 'Unknown error')}")
print(f"PRCXI9300Backend created matrix with ID: {self.matrix_info['MatrixId']}, result: {res}")
def run_protocol(self, protocol_id: str = None):
def run_protocol(self):
assert self.is_reset_ok, "PRCXI9300Backend is not reset successfully. Please call setup() first."
run_time = time.time()
if protocol_id == "" or protocol_id is None:
self.matrix_info = MatrixInfo(
MatrixId=f"{int(run_time)}",
MatrixName=f"protocol_{run_time}",
MatrixCount=len(self.tablets_info),
WorkTablets=self.tablets_info,
)
# print(json.dumps(self.matrix_info, indent=2))
if not len(self.matrix_id):
res = self.api_client.add_WorkTablet_Matrix(self.matrix_info)
assert res["Success"], f"Failed to create matrix: {res.get('Message', 'Unknown error')}"
print(f"PRCXI9300Backend created matrix with ID: {self.matrix_info['MatrixId']}, result: {res}")
solution_id = self.api_client.add_solution(
f"protocol_{run_time}", self.matrix_id, self.steps_todo_list
f"protocol_{run_time}", self.matrix_info["MatrixId"], self.steps_todo_list
)
else:
solution_id = protocol_id
print(f"PRCXI9300Backend using predefined worktable {self.matrix_id}, skipping matrix creation.")
solution_id = self.api_client.add_solution(f"protocol_{run_time}", self.matrix_id, self.steps_todo_list)
print(f"PRCXI9300Backend created solution with ID: {solution_id}")
self.api_client.load_solution(solution_id)
print(json.dumps(self.steps_todo_list, indent=2))
@@ -1507,9 +1126,6 @@ class PRCXI9300Backend(LiquidHandlerBackend):
else:
await asyncio.sleep(1)
print("PRCXI9300 reset successfully.")
# self.api_client.update_clamp_jaw_position(self.matrix_id, self.plate_positions)
except ConnectionRefusedError as e:
raise RuntimeError(
f"Failed to connect to PRCXI9300 API at {self.host}:{self.port}. "
@@ -1533,33 +1149,33 @@ class PRCXI9300Backend(LiquidHandlerBackend):
axis = "Right"
else:
raise ValueError("Invalid use channels: " + str(_use_channels))
plate_slots = []
plate_indexes = []
for op in ops:
plate = op.resource.parent
deck = plate.parent
plate_slots.append(self._deck_plate_slot_no(plate, deck))
deck = plate.parent.parent
plate_index = deck.children.index(plate.parent)
# print(f"Plate index: {plate_index}, Plate name: {plate.name}")
# print(f"Number of children in deck: {len(deck.children)}")
if len(set(plate_slots)) != 1:
raise ValueError("All pickups must be from the same plate (slot). Found different slots: " + str(plate_slots))
plate_indexes.append(plate_index)
if len(set(plate_indexes)) != 1:
raise ValueError("All pickups must be from the same plate. Found different plates: " + str(plate_indexes))
_rack = ops[0].resource.parent
ny = self._resource_num_items_y(_rack)
tip_columns = []
for op in ops:
tipspot = op.resource
if self._resource_num_items_y(tipspot.parent) != ny:
raise ValueError("All pickups must use tip racks with the same num_items_y")
tipspot_index = tipspot.parent.children.index(tipspot)
tip_columns.append(tipspot_index // ny)
tip_columns.append(tipspot_index // 8)
if len(set(tip_columns)) != 1:
raise ValueError(
"All pickups must be from the same tip column. Found different columns: " + str(tip_columns)
)
PlateNo = plate_slots[0]
PlateNo = plate_indexes[0] + 1
hole_col = tip_columns[0] + 1
hole_row = 1
if self.num_channels != 8:
hole_row = tipspot_index % ny + 1
if self._num_channels == 1:
hole_row = tipspot_index % 8 + 1
step = self.api_client.Load(
axis=axis,
@@ -1570,8 +1186,8 @@ class PRCXI9300Backend(LiquidHandlerBackend):
hole_col=hole_col,
blending_times=0,
balance_height=0,
plate_or_hole=f"H{hole_col}-{ny},T{PlateNo}",
hole_numbers=f"{(hole_col - 1) * ny + hole_row}" if self._num_channels != 8 else "1,2,3,4,5",
plate_or_hole=f"H{hole_col}-8,T{PlateNo}",
hole_numbers=f"{(hole_col - 1) * 8 + hole_row}" if self._num_channels == 1 else "1,2,3,4,5",
)
self.steps_todo_list.append(step)
@@ -1589,9 +1205,8 @@ class PRCXI9300Backend(LiquidHandlerBackend):
raise ValueError("Invalid use channels: " + str(_use_channels))
# 检查trash #
if ops[0].resource.name == "trash":
_plate = ops[0].resource
_deck = _plate.parent
PlateNo = self._deck_plate_slot_no(_plate, _deck)
PlateNo = ops[0].resource.parent.parent.children.index(ops[0].resource.parent) + 1
step = self.api_client.UnLoad(
axis=axis,
@@ -1609,35 +1224,32 @@ class PRCXI9300Backend(LiquidHandlerBackend):
return
# print(ops[0].resource.parent.children.index(ops[0].resource))
plate_slots = []
plate_indexes = []
for op in ops:
plate = op.resource.parent
deck = plate.parent
plate_slots.append(self._deck_plate_slot_no(plate, deck))
if len(set(plate_slots)) != 1:
deck = plate.parent.parent
plate_index = deck.children.index(plate.parent)
plate_indexes.append(plate_index)
if len(set(plate_indexes)) != 1:
raise ValueError(
"All drop_tips must be from the same plate (slot). Found different slots: " + str(plate_slots)
"All drop_tips must be from the same plate. Found different plates: " + str(plate_indexes)
)
_rack = ops[0].resource.parent
ny = self._resource_num_items_y(_rack)
tip_columns = []
for op in ops:
tipspot = op.resource
if self._resource_num_items_y(tipspot.parent) != ny:
raise ValueError("All drop_tips must use tip racks with the same num_items_y")
tipspot_index = tipspot.parent.children.index(tipspot)
tip_columns.append(tipspot_index // ny)
tip_columns.append(tipspot_index // 8)
if len(set(tip_columns)) != 1:
raise ValueError(
"All drop_tips must be from the same tip column. Found different columns: " + str(tip_columns)
)
PlateNo = plate_slots[0]
PlateNo = plate_indexes[0] + 1
hole_col = tip_columns[0] + 1
hole_row = 1
if self.num_channels != 8:
hole_row = tipspot_index % ny + 1
if self.channel_num == 1:
hole_row = tipspot_index % 8 + 1
step = self.api_client.UnLoad(
axis=axis,
@@ -1648,7 +1260,7 @@ class PRCXI9300Backend(LiquidHandlerBackend):
hole_col=hole_col,
blending_times=0,
balance_height=0,
plate_or_hole=f"H{hole_col}-{ny},T{PlateNo}",
plate_or_hole=f"H{hole_col}-8,T{PlateNo}",
hole_numbers="1,2,3,4,5,6,7,8",
)
self.steps_todo_list.append(step)
@@ -1662,43 +1274,34 @@ class PRCXI9300Backend(LiquidHandlerBackend):
offsets: Optional[Coordinate] = None,
mix_rate: Optional[float] = None,
none_keys: List[str] = [],
use_channels: Optional[List[int]] = [0],
):
"""Mix liquid in the specified resources."""
if use_channels == [0]:
axis = "Left"
elif use_channels == [1]:
axis = "Right"
else:
raise ValueError("Invalid use channels: " + str(use_channels))
plate_slots = []
plate_indexes = []
for op in targets:
deck = op.parent.parent.parent
plate = op.parent
plate_slots.append(self._deck_plate_slot_no(plate, deck))
plate_index = deck.children.index(plate.parent)
plate_indexes.append(plate_index)
if len(set(plate_slots)) != 1:
raise ValueError("All mix targets must be from the same plate (slot). Found different slots: " + str(plate_slots))
if len(set(plate_indexes)) != 1:
raise ValueError("All pickups must be from the same plate. Found different plates: " + str(plate_indexes))
_plate0 = targets[0].parent
ny = self._resource_num_items_y(_plate0)
tip_columns = []
for op in targets:
if self._resource_num_items_y(op.parent) != ny:
raise ValueError("All mix targets must be on plates with the same num_items_y")
tipspot_index = op.parent.children.index(op)
tip_columns.append(tipspot_index // ny)
tip_columns.append(tipspot_index // 8)
if len(set(tip_columns)) != 1:
raise ValueError(
"All mix targets must be in the same column group. Found different columns: " + str(tip_columns)
"All pickups must be from the same tip column. Found different columns: " + str(tip_columns)
)
PlateNo = plate_slots[0]
PlateNo = plate_indexes[0] + 1
hole_col = tip_columns[0] + 1
hole_row = 1
if self.num_channels != 8:
hole_row = tipspot_index % ny + 1
if self.num_channels == 1:
hole_row = tipspot_index % 8 + 1
assert mix_time > 0
step = self.api_client.Blending(
@@ -1709,7 +1312,7 @@ class PRCXI9300Backend(LiquidHandlerBackend):
hole_col=hole_col,
blending_times=mix_time,
balance_height=0,
plate_or_hole=f"H{hole_col}-{ny},T{PlateNo}",
plate_or_hole=f"H{hole_col}-8,T{PlateNo}",
hole_numbers="1,2,3,4,5,6,7,8",
)
self.steps_todo_list.append(step)
@@ -1726,39 +1329,36 @@ class PRCXI9300Backend(LiquidHandlerBackend):
axis = "Right"
else:
raise ValueError("Invalid use channels: " + str(_use_channels))
plate_slots = []
plate_indexes = []
for op in ops:
plate = op.resource.parent
deck = plate.parent
plate_slots.append(self._deck_plate_slot_no(plate, deck))
deck = plate.parent.parent
plate_index = deck.children.index(plate.parent)
plate_indexes.append(plate_index)
if len(set(plate_slots)) != 1:
raise ValueError("All aspirate must be from the same plate (slot). Found different slots: " + str(plate_slots))
if len(set(plate_indexes)) != 1:
raise ValueError("All pickups must be from the same plate. Found different plates: " + str(plate_indexes))
_plate0 = ops[0].resource.parent
ny = self._resource_num_items_y(_plate0)
tip_columns = []
for op in ops:
tipspot = op.resource
if self._resource_num_items_y(tipspot.parent) != ny:
raise ValueError("All aspirate wells must be on plates with the same num_items_y")
tipspot_index = tipspot.parent.children.index(tipspot)
tip_columns.append(tipspot_index // ny)
tip_columns.append(tipspot_index // 8)
if len(set(tip_columns)) != 1:
raise ValueError(
"All aspirate must be from the same tip column. Found different columns: " + str(tip_columns)
"All pickups must be from the same tip column. Found different columns: " + str(tip_columns)
)
volumes = [op.volume for op in ops]
if len(set(volumes)) != 1:
raise ValueError("All aspirate volumes must be the same. Found different volumes: " + str(volumes))
PlateNo = plate_slots[0]
PlateNo = plate_indexes[0] + 1
hole_col = tip_columns[0] + 1
hole_row = 1
if self.num_channels != 8:
hole_row = tipspot_index % ny + 1
if self.num_channels == 1:
hole_row = tipspot_index % 8 + 1
step = self.api_client.Imbibing(
axis=axis,
@@ -1769,7 +1369,7 @@ class PRCXI9300Backend(LiquidHandlerBackend):
hole_col=hole_col,
blending_times=0,
balance_height=0,
plate_or_hole=f"H{hole_col}-{ny},T{PlateNo}",
plate_or_hole=f"H{hole_col}-8,T{PlateNo}",
hole_numbers="1,2,3,4,5,6,7,8",
)
self.steps_todo_list.append(step)
@@ -1786,24 +1386,21 @@ class PRCXI9300Backend(LiquidHandlerBackend):
axis = "Right"
else:
raise ValueError("Invalid use channels: " + str(_use_channels))
plate_slots = []
plate_indexes = []
for op in ops:
plate = op.resource.parent
deck = plate.parent
plate_slots.append(self._deck_plate_slot_no(plate, deck))
deck = plate.parent.parent
plate_index = deck.children.index(plate.parent)
plate_indexes.append(plate_index)
if len(set(plate_slots)) != 1:
raise ValueError("All dispense must be from the same plate (slot). Found different slots: " + str(plate_slots))
if len(set(plate_indexes)) != 1:
raise ValueError("All dispense must be from the same plate. Found different plates: " + str(plate_indexes))
_plate0 = ops[0].resource.parent
ny = self._resource_num_items_y(_plate0)
tip_columns = []
for op in ops:
tipspot = op.resource
if self._resource_num_items_y(tipspot.parent) != ny:
raise ValueError("All dispense wells must be on plates with the same num_items_y")
tipspot_index = tipspot.parent.children.index(tipspot)
tip_columns.append(tipspot_index // ny)
tip_columns.append(tipspot_index // 8)
if len(set(tip_columns)) != 1:
raise ValueError(
@@ -1814,12 +1411,12 @@ class PRCXI9300Backend(LiquidHandlerBackend):
if len(set(volumes)) != 1:
raise ValueError("All dispense volumes must be the same. Found different volumes: " + str(volumes))
PlateNo = plate_slots[0]
PlateNo = plate_indexes[0] + 1
hole_col = tip_columns[0] + 1
hole_row = 1
if self.num_channels != 8:
hole_row = tipspot_index % ny + 1
if self.num_channels == 1:
hole_row = tipspot_index % 8 + 1
step = self.api_client.Tapping(
axis=axis,
@@ -1830,7 +1427,7 @@ class PRCXI9300Backend(LiquidHandlerBackend):
hole_col=hole_col,
blending_times=0,
balance_height=0,
plate_or_hole=f"H{hole_col}-{ny},T{PlateNo}",
plate_or_hole=f"H{hole_col}-8,T{PlateNo}",
hole_numbers="1,2,3,4,5,6,7,8",
)
self.steps_todo_list.append(step)
@@ -2026,21 +1623,6 @@ class PRCXI9300Api:
"""GetWorkTabletMatrixById"""
return self.call("IMatrix", "GetWorkTabletMatrixById", [matrix_id])
def update_clamp_jaw_position(self, target_matrix_id: str, plate_positions: List[Dict[str, Any]]):
position_params = {
"MatrixId": target_matrix_id,
"WorkTablets": plate_positions
}
return self.call("IMatrix", "UpdateClampJawPosition", [position_params])
def update_pipetting_position(self, target_matrix_id: str, pipetting_positions: List[Dict[str, Any]]):
"""UpdatePipettingPosition - 更新移液位置"""
position_params = {
"MatrixId": target_matrix_id,
"WorkTablets": pipetting_positions
}
return self.call("IMatrix", "UpdatePipettingPosition", [position_params])
def add_WorkTablet_Matrix(self, matrix: MatrixInfo):
return self.call("IMatrix", "AddWorkTabletMatrix2" if self.is_9320 else "AddWorkTabletMatrix", [matrix])
@@ -2297,20 +1879,8 @@ class DefaultLayout:
self.rows = 2
self.columns = 3
self.layout = [1, 2, 3, 4, 5, 6]
self.trash_slot = 6
self.default_layout = {
"MatrixId": f"{time.time()}",
"MatrixName": f"{time.time()}",
"MatrixCount": 6,
"WorkTablets": [
{"Number": 1, "Code": "T1", "Material": {"uuid": "57b1e4711e9e4a32b529f3132fc5931f", "materialEnum": 0}},
{"Number": 2, "Code": "T2", "Material": {"uuid": "57b1e4711e9e4a32b529f3132fc5931f", "materialEnum": 0}},
{"Number": 3, "Code": "T3", "Material": {"uuid": "57b1e4711e9e4a32b529f3132fc5931f", "materialEnum": 0}},
{"Number": 4, "Code": "T4", "Material": {"uuid": "57b1e4711e9e4a32b529f3132fc5931f", "materialEnum": 0}},
{"Number": 5, "Code": "T5", "Material": {"uuid": "57b1e4711e9e4a32b529f3132fc5931f", "materialEnum": 0}},
{"Number": 6, "Code": "T6", "Material": {"uuid": "730067cf07ae43849ddf4034299030e9", "materialEnum": 0}}, # trash
],
}
self.trash_slot = 3
self.waste_liquid_slot = 6
elif product_name == "PRCXI9320":
self.rows = 4
@@ -2407,15 +1977,13 @@ class DefaultLayout:
}
def get_layout(self) -> Dict[str, Any]:
result = {
return {
"rows": self.rows,
"columns": self.columns,
"layout": self.layout,
"trash_slot": self.trash_slot,
"waste_liquid_slot": self.waste_liquid_slot,
}
if hasattr(self, 'waste_liquid_slot'):
result["waste_liquid_slot"] = self.waste_liquid_slot
return result
def get_trash_slot(self) -> int:
return self.trash_slot
@@ -2433,18 +2001,15 @@ class DefaultLayout:
if material_name not in self.labresource:
raise ValueError(f"Material {reagent_name} not found in lab resources.")
# 预留位置动态计算
reserved_positions = {self.trash_slot}
if hasattr(self, 'waste_liquid_slot'):
reserved_positions.add(self.waste_liquid_slot)
total_slots = self.rows * self.columns
available_positions = [i for i in range(1, total_slots + 1) if i not in reserved_positions]
# 预留位置12和16不
reserved_positions = {12, 16}
available_positions = [i for i in range(1, 17) if i not in reserved_positions]
# 计算总需求
total_needed = sum(count for _, _, count in needs)
if total_needed > len(available_positions):
raise ValueError(
f"需要 {total_needed} 个位置,但只有 {len(available_positions)} 个可用位置(排除预留位置 {reserved_positions}"
f"需要 {total_needed} 个位置,但只有 {len(available_positions)} 个可用位置(排除位置12和16"
)
# 依次分配位置

View File

@@ -1,4 +1,4 @@
from typing import Any, Callable, Dict, List, Optional, Tuple
from typing import Optional
from pylabrobot.resources import Tube, Coordinate
from pylabrobot.resources.well import Well, WellBottomType, CrossSectionType
from pylabrobot.resources.tip import Tip, TipCreator
@@ -838,102 +838,4 @@ def PRCXI_30mm_Adapter(name: str) -> PRCXI9300PlateAdapter:
"Name": "30mm适配器",
"SupplyType": 2
}
)
# ---------------------------------------------------------------------------
# 协议上传 / workflow 用:与设备端耗材字典字段对齐的模板描述(供 common 自动匹配)
# ---------------------------------------------------------------------------
_PRCXI_TEMPLATE_SPECS_CACHE: Optional[List[Dict[str, Any]]] = None
def _probe_prcxi_resource(factory: Callable[..., Any]) -> Any:
probe = "__unilab_template_probe__"
if factory.__name__ == "PRCXI_trash":
return factory()
return factory(probe)
def _first_child_capacity_for_match(resource: Any) -> float:
"""Well max_volume 或 Tip 的 maximal_volume用于与设备端 Volume 类似的打分。"""
ch = getattr(resource, "children", None) or []
if not ch:
return 0.0
c0 = ch[0]
mv = getattr(c0, "max_volume", None)
if mv is not None:
return float(mv)
tip = getattr(c0, "tip", None)
if tip is not None:
mv2 = getattr(tip, "maximal_volume", None)
if mv2 is not None:
return float(mv2)
return 0.0
# (factory, kind) — 不含各类 Adapter避免与真实板子误匹配
PRCXI_TEMPLATE_FACTORY_KINDS: List[Tuple[Callable[..., Any], str]] = [
(PRCXI_BioER_96_wellplate, "plate"),
(PRCXI_nest_1_troughplate, "plate"),
(PRCXI_BioRad_384_wellplate, "plate"),
(PRCXI_AGenBio_4_troughplate, "plate"),
(PRCXI_nest_12_troughplate, "plate"),
(PRCXI_CellTreat_96_wellplate, "plate"),
(PRCXI_10ul_eTips, "tip_rack"),
(PRCXI_300ul_Tips, "tip_rack"),
(PRCXI_PCR_Plate_200uL_nonskirted, "plate"),
(PRCXI_PCR_Plate_200uL_semiskirted, "plate"),
(PRCXI_PCR_Plate_200uL_skirted, "plate"),
(PRCXI_trash, "trash"),
(PRCXI_96_DeepWell, "plate"),
(PRCXI_EP_Adapter, "tube_rack"),
(PRCXI_1250uL_Tips, "tip_rack"),
(PRCXI_10uL_Tips, "tip_rack"),
(PRCXI_1000uL_Tips, "tip_rack"),
(PRCXI_200uL_Tips, "tip_rack"),
(PRCXI_48_DeepWell, "plate"),
]
def get_prcxi_labware_template_specs() -> List[Dict[str, Any]]:
"""返回与 ``prcxi._match_and_create_matrix`` 中耗材字段兼容的模板列表,用于按孔数+容量打分。"""
global _PRCXI_TEMPLATE_SPECS_CACHE
if _PRCXI_TEMPLATE_SPECS_CACHE is not None:
return _PRCXI_TEMPLATE_SPECS_CACHE
out: List[Dict[str, Any]] = []
for factory, kind in PRCXI_TEMPLATE_FACTORY_KINDS:
try:
r = _probe_prcxi_resource(factory)
except Exception:
continue
nx = int(getattr(r, "num_items_x", None) or 0)
ny = int(getattr(r, "num_items_y", None) or 0)
nchild = len(getattr(r, "children", []) or [])
hole_count = nx * ny if nx > 0 and ny > 0 else nchild
hole_row = ny if nx > 0 and ny > 0 else 0
hole_col = nx if nx > 0 and ny > 0 else 0
mi = getattr(r, "material_info", None) or {}
vol = _first_child_capacity_for_match(r)
menum = mi.get("materialEnum")
if menum is None and kind == "tip_rack":
menum = 1
elif menum is None and kind == "trash":
menum = 6
out.append(
{
"class_name": factory.__name__,
"kind": kind,
"materialEnum": menum,
"HoleRow": hole_row,
"HoleColum": hole_col,
"Volume": vol,
"hole_count": hole_count,
"material_uuid": mi.get("uuid"),
"material_code": mi.get("Code"),
}
)
_PRCXI_TEMPLATE_SPECS_CACHE = out
return out
)

View File

@@ -1,150 +0,0 @@
from typing import Any, Dict, Optional
from .prcxi import PRCXI9300ModuleSite
class PRCXI9300FunctionalModule(PRCXI9300ModuleSite):
"""
PRCXI 9300 功能模块基类(加热/冷却/震荡/加热震荡/磁吸等)。
设计目标:
- 作为一个可以在工作台上拖拽摆放的实体资源(继承自 PRCXI9300ModuleSite -> ItemizedCarrier
- 顶面存在一个站点site可吸附标准板类资源plate / tip_rack / tube_rack 等)。
- 支持注入 `material_info` (UUID 等),并且在 serialize_state 时做安全过滤。
"""
def __init__(
self,
name: str,
size_x: float,
size_y: float,
size_z: float,
module_type: Optional[str] = None,
category: str = "module",
model: Optional[str] = None,
material_info: Optional[Dict[str, Any]] = None,
**kwargs: Any,
):
super().__init__(
name=name,
size_x=size_x,
size_y=size_y,
size_z=size_z,
material_info=material_info,
model=model,
category=category,
**kwargs,
)
# 记录模块类型(加热 / 冷却 / 震荡 / 加热震荡 / 磁吸)
self.module_type = module_type or "generic"
# 与 PRCXI9300PlateAdapter 一致,使用 _unilabos_state 保存扩展信息
if not hasattr(self, "_unilabos_state") or self._unilabos_state is None:
self._unilabos_state = {}
# super().__init__ 已经在有 material_info 时写入 "Material",这里仅确保存在
if material_info is not None and "Material" not in self._unilabos_state:
self._unilabos_state["Material"] = material_info
# 额外标记 category 和模块类型,便于前端或上层逻辑区分
self._unilabos_state.setdefault("category", category)
self._unilabos_state["module_type"] = module_type
# ============================================================================
# 具体功能模块定义
# 这里的尺寸和 material_info 目前为占位参数,后续可根据实际测量/JSON 配置进行更新。
# 顶面站点尺寸与模块外形一致,保证可以吸附标准 96 板/储液槽等。
# ============================================================================
def PRCXI_Heating_Module(name: str) -> PRCXI9300FunctionalModule:
"""加热模块(顶面可吸附标准板)。"""
return PRCXI9300FunctionalModule(
name=name,
size_x=127.76,
size_y=85.48,
size_z=40.0,
module_type="heating",
model="PRCXI_Heating_Module",
material_info={
"uuid": "TODO-HEATING-MODULE-UUID",
"Code": "HEAT-MOD",
"Name": "PRCXI 加热模块",
"SupplyType": 3,
},
)
def PRCXI_MetalCooling_Module(name: str) -> PRCXI9300FunctionalModule:
"""金属冷却模块(顶面可吸附标准板)。"""
return PRCXI9300FunctionalModule(
name=name,
size_x=127.76,
size_y=85.48,
size_z=40.0,
module_type="metal_cooling",
model="PRCXI_MetalCooling_Module",
material_info={
"uuid": "TODO-METAL-COOLING-MODULE-UUID",
"Code": "METAL-COOL-MOD",
"Name": "PRCXI 金属冷却模块",
"SupplyType": 3,
},
)
def PRCXI_Shaking_Module(name: str) -> PRCXI9300FunctionalModule:
"""震荡模块(顶面可吸附标准板)。"""
return PRCXI9300FunctionalModule(
name=name,
size_x=127.76,
size_y=85.48,
size_z=50.0,
module_type="shaking",
model="PRCXI_Shaking_Module",
material_info={
"uuid": "TODO-SHAKING-MODULE-UUID",
"Code": "SHAKE-MOD",
"Name": "PRCXI 震荡模块",
"SupplyType": 3,
},
)
def PRCXI_Heating_Shaking_Module(name: str) -> PRCXI9300FunctionalModule:
"""加热震荡模块(顶面可吸附标准板)。"""
return PRCXI9300FunctionalModule(
name=name,
size_x=127.76,
size_y=85.48,
size_z=55.0,
module_type="heating_shaking",
model="PRCXI_Heating_Shaking_Module",
material_info={
"uuid": "TODO-HEATING-SHAKING-MODULE-UUID",
"Code": "HEAT-SHAKE-MOD",
"Name": "PRCXI 加热震荡模块",
"SupplyType": 3,
},
)
def PRCXI_Magnetic_Module(name: str) -> PRCXI9300FunctionalModule:
"""磁吸模块(顶面可吸附标准板)。"""
return PRCXI9300FunctionalModule(
name=name,
size_x=127.76,
size_y=85.48,
size_z=30.0,
module_type="magnetic",
model="PRCXI_Magnetic_Module",
material_info={
"uuid": "TODO-MAGNETIC-MODULE-UUID",
"Code": "MAG-MOD",
"Name": "PRCXI 磁吸模块",
"SupplyType": 3,
},
)

View File

@@ -59,7 +59,6 @@ class UniLiquidHandlerRvizBackend(LiquidHandlerBackend):
self.total_height = total_height
self.joint_config = kwargs.get("joint_config", None)
self.lh_device_id = kwargs.get("lh_device_id", "lh_joint_publisher")
self.simulate_rviz = kwargs.get("simulate_rviz", False)
if not rclpy.ok():
rclpy.init()
self.joint_state_publisher = None
@@ -70,7 +69,7 @@ class UniLiquidHandlerRvizBackend(LiquidHandlerBackend):
self.joint_state_publisher = LiquidHandlerJointPublisher(
joint_config=self.joint_config,
lh_device_id=self.lh_device_id,
simulate_rviz=self.simulate_rviz)
simulate_rviz=True)
# 启动ROS executor
self.executor = rclpy.executors.MultiThreadedExecutor()

View File

@@ -42,7 +42,6 @@ class LiquidHandlerJointPublisher(Node):
while self.resource_action is None:
self.resource_action = self.check_tf_update_actions()
time.sleep(1)
self.get_logger().info(f'Waiting for TfUpdate server: {self.resource_action}')
self.resource_action_client = ActionClient(self, SendCmd, self.resource_action)
while not self.resource_action_client.wait_for_server(timeout_sec=1.0):

View File

@@ -1,9 +1,5 @@
# 工作站抽象基类物料系统架构说明
## 设计理念
基于用户需求"请你帮我系统思考一下,工作站抽象基类的物料系统基类该如何构建",我们最终确定了一个**PyLabRobot Deck为中心**的简化架构。
### 核心原则
1. **PyLabRobot为物料管理核心**使用PyLabRobot的Deck系统作为物料管理的基础利用其成熟的Resource体系

View File

@@ -0,0 +1,113 @@
# Bioyond Cell 工作站 - 多订单返回示例
本文档说明了 `create_orders` 函数如何收集并返回所有订单的完成报文。
## 问题描述
之前的实现只会等待并返回第一个订单的完成报文,如果有多个订单(例如从 Excel 解析出 3 个订单),只能得到第一个订单的推送信息。
## 解决方案
修改后的 `create_orders` 函数现在会:
1. **提取所有 orderCode**:从 LIMS 接口返回的 `data` 列表中提取所有订单编号
2. **逐个等待完成**:遍历所有 orderCode调用 `wait_for_order_finish` 等待每个订单完成
3. **收集所有报文**:将每个订单的完成报文存入 `all_reports` 列表
4. **统一返回**:返回包含所有订单报文的 JSON 格式数据
## 返回格式
```json
{
"status": "all_completed",
"total_orders": 3,
"reports": [
{
"token": "",
"request_time": "2025-12-24T15:32:09.2148671+08:00",
"data": {
"orderId": "3a1e614d-a082-c44a-60be-68647a35e6f1",
"orderCode": "BSO2025122400024",
"orderName": "DP20251224001",
"status": "30",
"workflowStatus": "completed",
"usedMaterials": [...]
}
},
{
"token": "",
"request_time": "2025-12-24T15:32:09.9999039+08:00",
"data": {
"orderId": "3a1e614d-a0a2-f7a9-9360-610021c9479d",
"orderCode": "BSO2025122400025",
"orderName": "DP20251224002",
"status": "30",
"workflowStatus": "completed",
"usedMaterials": [...]
}
},
{
"token": "",
"request_time": "2025-12-24T15:34:00.4139986+08:00",
"data": {
"orderId": "3a1e614d-a0cd-81ca-9f7f-2f4e93af01cd",
"orderCode": "BSO2025122400026",
"orderName": "DP20251224003",
"status": "30",
"workflowStatus": "completed",
"usedMaterials": [...]
}
}
],
"original_response": {...}
}
```
## 使用示例
```python
# 调用 create_orders
result = workstation.create_orders("20251224.xlsx")
# 访问返回数据
print(f"总订单数: {result['total_orders']}")
print(f"状态: {result['status']}")
# 遍历所有订单的报文
for i, report in enumerate(result['reports'], 1):
order_data = report.get('data', {})
print(f"\n订单 {i}:")
print(f" orderCode: {order_data.get('orderCode')}")
print(f" orderName: {order_data.get('orderName')}")
print(f" status: {order_data.get('status')}")
print(f" 使用物料数: {len(order_data.get('usedMaterials', []))}")
```
## 控制台输出示例
```
[create_orders] 即将提交订单数量: 3
[create_orders] 接口返回: {...}
[create_orders] 等待 3 个订单完成: ['BSO2025122400024', 'BSO2025122400025', 'BSO2025122400026']
[create_orders] 正在等待第 1/3 个订单: BSO2025122400024
[create_orders] ✓ 订单 BSO2025122400024 完成
[create_orders] 正在等待第 2/3 个订单: BSO2025122400025
[create_orders] ✓ 订单 BSO2025122400025 完成
[create_orders] 正在等待第 3/3 个订单: BSO2025122400026
[create_orders] ✓ 订单 BSO2025122400026 完成
[create_orders] 所有订单已完成,共收集 3 个报文
实验记录本========================create_orders========================
返回报文数量: 3
报文 1: orderCode=BSO2025122400024, status=30
报文 2: orderCode=BSO2025122400025, status=30
报文 3: orderCode=BSO2025122400026, status=30
========================
```
## 关键改进
1.**等待所有订单**:不再只等待第一个订单,而是遍历所有 orderCode
2.**收集完整报文**:每个订单的完整推送报文都被保存在 `reports` 数组中
3.**详细日志**:清晰显示正在等待哪个订单,以及完成情况
4.**错误处理**:即使某个订单失败,也会记录其状态信息
5.**统一格式**:返回的 JSON 格式便于后续处理和分析

View File

@@ -0,0 +1,204 @@
# BioyondCellWorkstation JSON 配置迁移经验总结
**日期**: 2026-01-13
**目的**: 从 `config.py` 迁移到 JSON 配置文件
---
## 问题背景
原系统通过 `config.py` 管理配置,导致:
1. HTTP 服务重复启动(父类 `BioyondWorkstation` 和子类都启动)
2. 配置分散在代码中,不便于管理
3. 无法通过 JSON 统一配置所有参数
---
## 解决方案:嵌套配置结构
### JSON 结构设计
**正确示例** (嵌套在 `config` 中):
```json
{
"nodes": [{
"id": "bioyond_cell_workstation",
"config": {
"deck": {...},
"protocol_type": [],
"bioyond_config": {
"api_host": "http://172.16.11.219:44388",
"api_key": "8A819E5C",
"timeout": 30,
"HTTP_host": "172.16.11.206",
"HTTP_port": 8080,
"debug_mode": false,
"material_type_mappings": {...},
"warehouse_mapping": {...},
"solid_liquid_mappings": {...}
}
},
"data": {}
}]
}
```
**关键点**
-`bioyond_config` 放在 `config` 中(会传递到 `__init__`
- ❌ **不要**放在 `data` 中(`data` 是运行时状态,不会传递)
---
## Python 代码适配
### 1. 修改 `BioyondCellWorkstation.__init__` 签名
**文件**: `bioyond_cell_workstation.py`
```python
def __init__(self, bioyond_config: dict = None, deck=None, protocol_type=None, **kwargs):
"""
Args:
bioyond_config: 从 JSON 加载的配置字典
deck: Deck 配置
protocol_type: 协议类型
"""
# 验证配置
if bioyond_config is None:
raise ValueError("需要 bioyond_config 参数")
# 保存配置
self.bioyond_config = bioyond_config
# 设置 HTTP 服务去重标志
self.bioyond_config["_disable_auto_http_service"] = True
# 调用父类
super().__init__(bioyond_config=self.bioyond_config, deck=deck, **kwargs)
```
### 2. 替换全局变量引用
**修改前**(使用全局变量):
```python
from config import MATERIAL_TYPE_MAPPINGS, WAREHOUSE_MAPPING
def create_sample(self, board_type, ...):
carrier_type_id = MATERIAL_TYPE_MAPPINGS[board_type][1]
location_id = WAREHOUSE_MAPPING[warehouse_name]["site_uuids"][location_code]
```
**修改后**(从配置读取):
```python
def create_sample(self, board_type, ...):
carrier_type_id = self.bioyond_config['material_type_mappings'][board_type][1]
location_id = self.bioyond_config['warehouse_mapping'][warehouse_name]["site_uuids"][location_code]
```
### 3. 修复父类配置访问
`station.py` 中安全访问配置默认值:
```python
# 修改前(会 KeyError
self._http_service_config = {
"host": bioyond_config.get("http_service_host", HTTP_SERVICE_CONFIG["http_service_host"])
}
# 修改后(安全访问)
self._http_service_config = {
"host": bioyond_config.get("http_service_host", HTTP_SERVICE_CONFIG.get("http_service_host", ""))
}
```
---
## 常见陷阱
### ❌ 错误1将配置放在 `data` 字段
```json
"config": {"deck": {...}},
"data": {"bioyond_config": {...}} // ❌ 不会传递到 __init__
```
### ❌ 错误2扁平化配置已废弃方案
虽然扁平化也能工作,但不推荐:
```json
"config": {
"deck": {...},
"api_host": "...", // ❌ 不够清晰
"api_key": "...",
"HTTP_host": "..."
}
```
### ❌ 错误3忘记替换全局变量引用
代码中直接使用 `MATERIAL_TYPE_MAPPINGS` 等全局变量会导致 `NameError`
---
## 云端同步注意事项
使用 `--upload_registry` 时,云端配置可能覆盖本地配置:
- 首次上传时确保 JSON 完整
- 或使用新的 `ak/sk` 避免旧配置干扰
- 调试时可暂时移除 `--upload_registry` 参数
---
## 验证清单
启动成功后应看到:
```
✅ 从 JSON 配置加载 bioyond_config 成功
API Host: http://...
HTTP Service: ...
✅ BioyondCellWorkstation 初始化完成
Loaded ResourceTreeSet with ... nodes
```
运行时不应出现:
-`NameError: name 'MATERIAL_TYPE_MAPPINGS' is not defined`
-`KeyError: 'http_service_host'`
-`bioyond_config 缺少必需参数`
---
## 调试经验
1. **添加调试日志**查看参数传递链路:
- `graphio.py`: JSON 加载后的 config 内容
- `initialize_device.py`: `device_config.res_content.config` 的键
- `bioyond_cell_workstation.py`: `__init__` 接收到的参数
2. **config vs data 区别**
- `config`: 初始化参数,传递给 `__init__`
- `data`: 运行时状态,不传递给 `__init__`
3. **参数名必须匹配**
- JSON 中的键名必须与 `__init__` 参数名完全一致
4. **调试代码清理**:完成后记得删除调试日志(🔍 DEBUG 标记)
---
## 修改文件清单
| 文件 | 修改内容 |
|------|----------|
| `yibin_electrolyte_config.json` | 创建嵌套 `config.bioyond_config` 结构 |
| `bioyond_cell_workstation.py` | 修改 `__init__` 接收 `bioyond_config`,替换所有全局变量引用 |
| `station.py` | 安全访问 `HTTP_SERVICE_CONFIG` 默认值 |
---
## 参考代码位置
- JSON 配置示例: `yibin_electrolyte_config.json` L12-L353
- `__init__` 实现: `bioyond_cell_workstation.py` L39-L94
- 全局变量替换示例: `bioyond_cell_workstation.py` L2005, L1863, L1966
- HTTP 服务配置: `station.py` L629-L634
---
**总结**: 使用嵌套结构将所有配置放在 `config.bioyond_config` 中,修改 `__init__` 直接接收该参数,并替换所有全局变量引用为 `self.bioyond_config` 访问。

View File

@@ -0,0 +1,312 @@
# BioyondCell 配置迁移修改总结
**日期**: 2026-01-13
**目标**: 从 `config.py` 完全迁移到 JSON 配置,消除所有全局变量依赖
---
## 📋 修改概览
本次修改完成了 BioyondCell 模块从 Python 配置文件到 JSON 配置的完整迁移,并清理了所有对 `config.py` 全局变量的依赖。
### 核心成果
- ✅ 完全移除对 `config.py` 的导入依赖
- ✅ 使用嵌套 JSON 结构 `config.bioyond_config`
- ✅ 修复 7 处 `bioyond_cell_workstation.py` 中的全局变量引用
- ✅ 修复 3 处其他文件中的全局变量引用
- ✅ HTTP 服务去重机制完善
- ✅ 系统成功启动并正常运行
---
## 🔧 修改文件清单
### 1. JSON 配置文件
**文件**: `yibin_electrolyte_config.json`
**修改**:
- 采用嵌套结构将所有配置放在 `config.bioyond_config`
- 包含:`api_host`, `api_key`, `HTTP_host`, `HTTP_port`, `material_type_mappings`, `warehouse_mapping`, `solid_liquid_mappings`
**示例结构**:
```json
{
"nodes": [{
"id": "bioyond_cell_workstation",
"config": {
"deck": {...},
"protocol_type": [],
"bioyond_config": {
"api_host": "http://172.16.11.219:44388",
"api_key": "8A819E5C",
"HTTP_host": "172.16.11.206",
"HTTP_port": 8080,
"material_type_mappings": {...},
"warehouse_mapping": {...},
"solid_liquid_mappings": {...}
}
}
}]
}
```
---
### 2. bioyond_cell_workstation.py
**位置**: `unilabos/devices/workstation/bioyond_studio/bioyond_cell/bioyond_cell_workstation.py`
#### 修改 A: `__init__` 方法签名 (L39-99)
**修改前**:
```python
def __init__(self, deck=None, protocol_type=None, **kwargs):
# 从 kwargs 收集配置字段
self.bioyond_config = {}
for field in bioyond_field_names:
if field in kwargs:
self.bioyond_config[field] = kwargs.pop(field)
```
**修改后**:
```python
def __init__(self, bioyond_config: dict = None, deck=None, protocol_type=None, **kwargs):
"""直接接收 bioyond_config 参数"""
if bioyond_config is None:
raise ValueError("需要 bioyond_config 参数")
self.bioyond_config = bioyond_config
# 设置 HTTP 服务去重标志
self.bioyond_config["_disable_auto_http_service"] = True
super().__init__(bioyond_config=self.bioyond_config, deck=deck, **kwargs)
```
#### 修改 B: 替换全局变量引用 (7 处)
| 位置 | 原代码 | 修改后 |
|------|--------|--------|
| L2005 | `MATERIAL_TYPE_MAPPINGS[board_type][1]` | `self.bioyond_config['material_type_mappings'][board_type][1]` |
| L2006 | `MATERIAL_TYPE_MAPPINGS[bottle_type][1]` | `self.bioyond_config['material_type_mappings'][bottle_type][1]` |
| L2009 | `WAREHOUSE_MAPPING` | `self.bioyond_config['warehouse_mapping']` |
| L2013 | `WAREHOUSE_MAPPING[warehouse_name]` | `self.bioyond_config['warehouse_mapping'][warehouse_name]` |
| L2017 | `WAREHOUSE_MAPPING[warehouse_name]["site_uuids"]` | `self.bioyond_config['warehouse_mapping'][warehouse_name]["site_uuids"]` |
| L1863 | `SOLID_LIQUID_MAPPINGS.get(material_name)` | `self.bioyond_config.get('solid_liquid_mappings', {}).get(material_name)` |
| L1966, L1976 | `MATERIAL_TYPE_MAPPINGS.items()` | `self.bioyond_config['material_type_mappings'].items()` |
---
### 3. station.py
**位置**: `unilabos/devices/workstation/bioyond_studio/station.py`
#### 修改 A: 删除 config 导入 (L26-28)
**修改前**:
```python
from unilabos.devices.workstation.bioyond_studio.config import (
API_CONFIG, WORKFLOW_MAPPINGS, MATERIAL_TYPE_MAPPINGS, WAREHOUSE_MAPPING, HTTP_SERVICE_CONFIG
)
```
**修改后**:
```python
# 已删除此导入
```
#### 修改 B: `_create_communication_module` 方法 (L691-702)
**修改前**:
```python
def _create_communication_module(self, config: Optional[Dict[str, Any]] = None) -> None:
default_config = {
**API_CONFIG,
"workflow_mappings": WORKFLOW_MAPPINGS,
"material_type_mappings": MATERIAL_TYPE_MAPPINGS,
"warehouse_mapping": WAREHOUSE_MAPPING
}
if config:
self.bioyond_config = {**default_config, **config}
else:
self.bioyond_config = default_config
```
**修改后**:
```python
def _create_communication_module(self, config: Optional[Dict[str, Any]] = None) -> None:
"""创建Bioyond通信模块"""
# 使用传入的 config 参数(来自 bioyond_config
# 不再依赖全局变量 API_CONFIG 等
if config:
self.bioyond_config = config
else:
# 如果没有传入配置,创建空配置(用于测试或兼容性)
self.bioyond_config = {}
self.hardware_interface = BioyondV1RPC(self.bioyond_config)
```
#### 修改 C: HTTP 服务配置 (L627-632)
**修改前**:
```python
self._http_service_config = {
"host": bioyond_config.get("http_service_host", HTTP_SERVICE_CONFIG.get("http_service_host", "")),
"port": bioyond_config.get("http_service_port", HTTP_SERVICE_CONFIG.get("http_service_port", 0))
}
```
**修改后**:
```python
self._http_service_config = {
"host": bioyond_config.get("http_service_host", bioyond_config.get("HTTP_host", "")),
"port": bioyond_config.get("http_service_port", bioyond_config.get("HTTP_port", 0))
}
```
---
### 4. bioyond_rpc.py
**位置**: `unilabos/devices/workstation/bioyond_studio/bioyond_rpc.py`
#### 修改 A: 删除 config 导入 (L12)
**修改前**:
```python
from unilabos.devices.workstation.bioyond_studio.config import LOCATION_MAPPING
```
**修改后**:
```python
# 已删除此导入
```
#### 修改 B: `material_outbound` 方法 (L278-280)
**修改前**:
```python
def material_outbound(self, material_id: str, location_name: str, quantity: int) -> dict:
"""指定库位出库物料(通过库位名称)"""
location_id = LOCATION_MAPPING.get(location_name, location_name)
```
**修改后**:
```python
def material_outbound(self, material_id: str, location_name: str, quantity: int) -> dict:
"""指定库位出库物料(通过库位名称)"""
# location_name 参数实际上应该直接是 location_id (UUID)
location_id = location_name
```
**说明**: `LOCATION_MAPPING``config-0113.py` 中本来就是空字典 `{}`,所以直接使用 `location_name` 逻辑等价。
---
## 🎯 关键设计决策
### 1. 嵌套 vs 扁平配置
**选择**: 嵌套结构 `config.bioyond_config`
**理由**:
- ✅ 语义清晰,配置分组明确
- ✅ 参数传递直观,直接对应 `__init__` 参数
- ✅ 易于维护,不需要硬编码字段列表
- ✅ 符合 UniLab 设计模式
### 2. HTTP 服务去重
**实现**: 子类设置 `_disable_auto_http_service` 标志
```python
# bioyond_cell_workstation.py
self.bioyond_config["_disable_auto_http_service"] = True
# station.py (post_init)
if self.bioyond_config.get("_disable_auto_http_service"):
logger.info("子类已自行管理HTTP服务跳过自动启动")
return
```
### 3. 全局变量替换策略
**原则**: 所有配置从 `self.bioyond_config` 获取
**模式**:
```python
# 修改前
from config import MATERIAL_TYPE_MAPPINGS
carrier_type_id = MATERIAL_TYPE_MAPPINGS[board_type][1]
# 修改后
carrier_type_id = self.bioyond_config['material_type_mappings'][board_type][1]
```
---
## ✅ 验证结果
### 启动成功日志
```
✅ 从 JSON 配置加载 bioyond_config 成功
API Host: http://172.16.11.219:44388
HTTP Service: 172.16.11.206:8080
🔧 已设置 _disable_auto_http_service 标志,防止 HTTP 服务重复启动
✅ BioyondCellWorkstation 初始化完成
Loaded ResourceTreeSet with 1 trees, 1785 total nodes
```
### 功能验证
- ✅ 订单创建 (`create_orders_v2`)
- ✅ 质量比计算
- ✅ 物料转移 (`transfer_3_to_2_to_1`)
- ✅ HTTP 报送接收 (step_finish, sample_finish, order_finish)
- ✅ 等待机制 (`wait_for_order_finish`)
- ✅ 仓库 UUID 映射
- ✅ 物料类型映射
---
## 📚 相关文档
- **配置迁移经验**: `2026-01-13_JSON配置迁移经验.md`
- **任务清单**: `C:\Users\AndyXie\.gemini\antigravity\brain\...\task.md`
- **实施计划**: `C:\Users\AndyXie\.gemini\antigravity\brain\...\implementation_plan.md`
---
## ⚠️ 注意事项
### 其他工作站模块
以下文件仍在使用 `config.py` 全局变量(未包含在本次修改中):
- `reaction_station.py` - 使用 `API_CONFIG`
- `experiment.py` - 使用 `API_CONFIG`, `WORKFLOW_MAPPINGS`, `MATERIAL_TYPE_MAPPINGS`
- `dispensing_station.py` - 使用 `API_CONFIG`, `WAREHOUSE_MAPPING`
- `station.py` L176, L177, L529, L530 - 动态导入 `WAREHOUSE_MAPPING`
**建议**: 后续可以统一迁移这些模块到 JSON 配置。
### config.py 文件
`config.py` 文件已恢复但**不再被 bioyond_cell 使用**。可以:
- 保留作为其他模块的参考
- 或者完全删除(如果其他模块也迁移完成)
---
## 🚀 下一步建议
1. **清理调试代码** ✅ (已完成)
2. **提交代码到 Git**
3. **迁移其他工作站模块** (可选)
4. **更新文档和启动脚本**
---
**修改完成日期**: 2026-01-13
**系统状态**: ✅ 稳定运行

View File

@@ -0,0 +1,157 @@
# 批量出库 Excel 模板使用说明
**文件**: `outbound_template.xlsx`
**用途**: 配合 `auto_batch_outbound_from_xlsx()` 方法进行批量出库操作
**API 端点**: `/api/lims/storage/auto-batch-out-bound`
---
## 📋 Excel 列说明
| 列名 | 说明 | 示例 | 必填 |
|------|------|------|------|
| `locationId` | **库位 IDUUID** | `3a19da43-57b5-294f-d663-154a1cc32270` | ✅ 是 |
| `warehouseId` | **仓库 ID 或名称** | `配液站内试剂仓库` | ✅ 是 |
| `quantity` | **出库数量** | `1.0`, `2.0` | ✅ 是 |
| `x` | **X 坐标(库位横向位置)** | `1`, `2`, `3` | ✅ 是 |
| `y` | **Y 坐标(库位纵向位置)** | `1`, `2`, `3` | ✅ 是 |
| `z` | **Z 坐标(库位层数/高度)** | `1`, `2`, `3` | ✅ 是 |
| `备注说明` | 可选备注信息 | `配液站内试剂仓库-A01` | ❌ 否 |
### 📐 坐标说明
**x, y, z** 是库位在仓库内的**三维坐标**
```
仓库(例如 WH4
├── Z=1第1层/加样头面)
│ ├── X=1, Y=1位置 A
│ ├── X=2, Y=1位置 B
│ ├── X=3, Y=1位置 C
│ └── ...
└── Z=2第2层/原液瓶面)
├── X=1, Y=1位置 A
├── X=2, Y=1位置 B
└── ...
```
- **warehouseId**: 指定哪个仓库WH3, WH4, 配液站等)
- **x, y, z**: 在该仓库内的三维坐标
- **locationId**: 该坐标位置的唯一 UUID
### 🎯 起点与终点
**重要说明**:批量出库模板**只规定了出库的"起点"**(从哪里取物料),**没有指定"终点"**(放到哪里)。
```
出库流程:
起点Excel 指定) → 终点LIMS/工作流决定)
locationId, x, y, z → 由 LIMS 系统或当前工作流自动分配
```
**终点由以下方式确定:**
- **LIMS 系统自动分配**:根据当前任务自动规划目标位置
- **工作流预定义**:在创建出库任务时已绑定目标位置
- **暂存区**:默认放到出库暂存区,等待下一步操作
💡 **对比**:上料操作(`auto_feeding4to3`)则有 `targetWH` 参数可以指定目标仓库
---
## 🔍 如何获取 UUID
### 方法 1从配置文件获取
参考 `yibin_electrolyte_config.json` 中的 `warehouse_mapping`
```json
{
"warehouse_mapping": {
"配液站内试剂仓库": {
"site_uuids": {
"A01": "3a19da43-57b5-294f-d663-154a1cc32270",
"B01": "3a19da43-57b5-7394-5f49-54efe2c9bef2",
"C01": "3a19da43-57b5-5e75-552f-8dbd0ad1075f"
}
},
"手动堆栈": {
"site_uuids": {
"A01": "3a19deae-2c7a-36f5-5e41-02c5b66feaea",
"A02": "3a19deae-2c7a-dc6d-c41e-ef285d946cfe"
}
}
}
}
```
### 方法 2通过 API 查询
```python
material_info = hardware_interface.material_id_query(workflow_id)
locations = material_info.get("locations", [])
```
---
## 📝 填写示例
### 示例 1从配液站内试剂仓库出库
| locationId | warehouseId | quantity | x | y | z | 备注说明 |
|------------|-------------|----------|---|---|---|----------|
| `3a19da43-57b5-294f-d663-154a1cc32270` | 配液站内试剂仓库 | 1 | 1 | 1 | 1 | A01 位置 |
| `3a19da43-57b5-7394-5f49-54efe2c9bef2` | 配液站内试剂仓库 | 2 | 2 | 1 | 1 | B01 位置 |
### 示例 2从手动堆栈出库
| locationId | warehouseId | quantity | x | y | z | 备注说明 |
|------------|-------------|----------|---|---|---|----------|
| `3a19deae-2c7a-36f5-5e41-02c5b66feaea` | 手动堆栈 | 1 | 1 | 1 | 1 | A01 |
| `3a19deae-2c7a-dc6d-c41e-ef285d946cfe` | 手动堆栈 | 1 | 1 | 2 | 1 | A02 |
---
## 💻 使用方法
```python
from bioyond_cell_workstation import BioyondCellWorkstation
# 初始化工作站
workstation = BioyondCellWorkstation(config=config, deck=deck)
# 调用批量出库方法
result = workstation.auto_batch_outbound_from_xlsx(
xlsx_path="outbound_template.xlsx"
)
```
---
## ⚠️ 注意事项
1. **locationId 必须是有效的 UUID**,不能使用库位名称
2. **x, y, z 坐标必须与 locationId 对应**,表示该库位在仓库内的位置
3. **quantity 必须是数字**,可以是整数或浮点数
4. Excel 文件必须包含表头行
5. 空行会被自动跳过
6. 确保 UUID 与实际库位对应,否则 API 会报错
---
## 📚 相关文件
- **配置文件**: `yibin_electrolyte_config.json`
- **Python 代码**: `bioyond_cell_workstation.py` (L630-695)
- **生成脚本**: `create_outbound_template.py`
- **上料模板**: `material_template.xlsx`
---
## 🔄 重新生成模板
```bash
conda activate newunilab
python create_outbound_template.py
```

View File

@@ -9,7 +9,7 @@ from datetime import datetime, timezone
from unilabos.device_comms.rpc import BaseRequest
from typing import Optional, List, Dict, Any
import json
from unilabos.devices.workstation.bioyond_studio.config import LOCATION_MAPPING
class SimpleLogger:
@@ -49,6 +49,14 @@ class BioyondV1RPC(BaseRequest):
self.config = config
self.api_key = config["api_key"]
self.host = config["api_host"]
# 初始化 location_mapping
# 直接从 warehouse_mapping 构建,确保数据源所谓的单一和结构化
self.location_mapping = {}
warehouse_mapping = self.config.get("warehouse_mapping", {})
for warehouse_name, warehouse_config in warehouse_mapping.items():
if "site_uuids" in warehouse_config:
self.location_mapping.update(warehouse_config["site_uuids"])
self._logger = SimpleLogger()
self.material_cache = {}
self._load_material_cache()
@@ -176,7 +184,40 @@ class BioyondV1RPC(BaseRequest):
return {}
print(f"add material data: {response['data']}")
return response.get("data", {})
# 自动更新缓存
data = response.get("data", {})
if data:
if isinstance(data, str):
# 如果返回的是字符串通常是ID
mat_id = data
name = params.get("name")
else:
# 如果返回的是字典尝试获取name和id
name = data.get("name") or params.get("name")
mat_id = data.get("id")
if name and mat_id:
self.material_cache[name] = mat_id
print(f"已自动更新缓存: {name} -> {mat_id}")
# 处理返回数据中的 details (如果有)
# 有些 API 返回结构可能直接包含 details或者在 data 字段中
details = data.get("details", []) if isinstance(data, dict) else []
if not details and isinstance(data, dict):
details = data.get("detail", [])
if details:
for detail in details:
d_name = detail.get("name")
# 尝试从不同字段获取 ID
d_id = detail.get("id") or detail.get("detailMaterialId")
if d_name and d_id:
self.material_cache[d_name] = d_id
print(f"已自动更新 detail 缓存: {d_name} -> {d_id}")
return data
def query_matial_type_id(self, data) -> list:
"""查找物料typeid"""
@@ -203,7 +244,7 @@ class BioyondV1RPC(BaseRequest):
params={
"apiKey": self.api_key,
"requestTime": self.get_current_time_iso8601(),
"data": {},
"data": 0,
})
if not response or response['code'] != 1:
return []
@@ -273,11 +314,19 @@ class BioyondV1RPC(BaseRequest):
if not response or response['code'] != 1:
return {}
# 自动更新缓存 - 移除被删除的物料
for name, mid in list(self.material_cache.items()):
if mid == material_id:
del self.material_cache[name]
print(f"已从缓存移除物料: {name}")
break
return response.get("data", {})
def material_outbound(self, material_id: str, location_name: str, quantity: int) -> dict:
"""指定库位出库物料(通过库位名称)"""
location_id = LOCATION_MAPPING.get(location_name, location_name)
location_id = self.location_mapping.get(location_name, location_name)
params = {
"materialId": material_id,
@@ -1103,6 +1152,10 @@ class BioyondV1RPC(BaseRequest):
for detail_material in detail_materials:
detail_name = detail_material.get("name")
detail_id = detail_material.get("detailMaterialId")
if not detail_id:
# 尝试其他可能的字段
detail_id = detail_material.get("id")
if detail_name and detail_id:
self.material_cache[detail_name] = detail_id
print(f"加载detail材料: {detail_name} -> ID: {detail_id}")
@@ -1123,6 +1176,14 @@ class BioyondV1RPC(BaseRequest):
print(f"从缓存找到材料: {material_name_or_id} -> ID: {material_id}")
return material_id
# 如果缓存中没有,尝试刷新缓存
print(f"缓存中未找到材料 '{material_name_or_id}',尝试刷新缓存...")
self.refresh_material_cache()
if material_name_or_id in self.material_cache:
material_id = self.material_cache[material_name_or_id]
print(f"刷新缓存后找到材料: {material_name_or_id} -> ID: {material_id}")
return material_id
print(f"警告: 未在缓存中找到材料名称 '{material_name_or_id}',将使用原值")
return material_name_or_id

View File

@@ -1,142 +0,0 @@
# config.py
"""
配置文件 - 包含所有配置信息和映射关系
"""
# API配置
API_CONFIG = {
"api_key": "",
"api_host": ""
}
# 工作流映射配置
WORKFLOW_MAPPINGS = {
"reactor_taken_out": "",
"reactor_taken_in": "",
"Solid_feeding_vials": "",
"Liquid_feeding_vials(non-titration)": "",
"Liquid_feeding_solvents": "",
"Liquid_feeding(titration)": "",
"liquid_feeding_beaker": "",
"Drip_back": "",
}
# 工作流名称到DisplaySectionName的映射
WORKFLOW_TO_SECTION_MAP = {
'reactor_taken_in': '反应器放入',
'liquid_feeding_beaker': '液体投料-烧杯',
'Liquid_feeding_vials(non-titration)': '液体投料-小瓶(非滴定)',
'Liquid_feeding_solvents': '液体投料-溶剂',
'Solid_feeding_vials': '固体投料-小瓶',
'Liquid_feeding(titration)': '液体投料-滴定',
'reactor_taken_out': '反应器取出'
}
# 库位映射配置
WAREHOUSE_MAPPING = {
"粉末堆栈": {
"uuid": "",
"site_uuids": {
# 样品板
"A1": "3a14198e-6929-31f0-8a22-0f98f72260df",
"A2": "3a14198e-6929-4379-affa-9a2935c17f99",
"A3": "3a14198e-6929-56da-9a1c-7f5fbd4ae8af",
"A4": "3a14198e-6929-5e99-2b79-80720f7cfb54",
"B1": "3a14198e-6929-f525-9a1b-1857552b28ee",
"B2": "3a14198e-6929-bf98-0fd5-26e1d68bf62d",
"B3": "3a14198e-6929-2d86-a468-602175a2b5aa",
"B4": "3a14198e-6929-1a98-ae57-e97660c489ad",
# 分装板
"C1": "3a14198e-6929-46fe-841e-03dd753f1e4a",
"C2": "3a14198e-6929-1bc9-a9bd-3b7ca66e7f95",
"C3": "3a14198e-6929-72ac-32ce-9b50245682b8",
"C4": "3a14198e-6929-3bd8-e6c7-4a9fd93be118",
"D1": "3a14198e-6929-8a0b-b686-6f4a2955c4e2",
"D2": "3a14198e-6929-dde1-fc78-34a84b71afdf",
"D3": "3a14198e-6929-a0ec-5f15-c0f9f339f963",
"D4": "3a14198e-6929-7ac8-915a-fea51cb2e884"
}
},
"溶液堆栈": {
"uuid": "",
"site_uuids": {
"A1": "3a14198e-d724-e036-afdc-2ae39a7f3383",
"A2": "3a14198e-d724-afa4-fc82-0ac8a9016791",
"A3": "3a14198e-d724-ca48-bb9e-7e85751e55b6",
"A4": "3a14198e-d724-df6d-5e32-5483b3cab583",
"B1": "3a14198e-d724-d818-6d4f-5725191a24b5",
"B2": "3a14198e-d724-be8a-5e0b-012675e195c6",
"B3": "3a14198e-d724-cc1e-5c2c-228a130f40a8",
"B4": "3a14198e-d724-1e28-c885-574c3df468d0",
"C1": "3a14198e-d724-b5bb-adf3-4c5a0da6fb31",
"C2": "3a14198e-d724-ab4e-48cb-817c3c146707",
"C3": "3a14198e-d724-7f18-1853-39d0c62e1d33",
"C4": "3a14198e-d724-28a2-a760-baa896f46b66",
"D1": "3a14198e-d724-d378-d266-2508a224a19f",
"D2": "3a14198e-d724-f56e-468b-0110a8feb36a",
"D3": "3a14198e-d724-0cf1-dea9-a1f40fe7e13c",
"D4": "3a14198e-d724-0ddd-9654-f9352a421de9"
}
},
"试剂堆栈": {
"uuid": "",
"site_uuids": {
"A1": "3a14198c-c2cf-8b40-af28-b467808f1c36",
"A2": "3a14198c-c2d0-f3e7-871a-e470d144296f",
"A3": "3a14198c-c2d0-dc7d-b8d0-e1d88cee3094",
"A4": "3a14198c-c2d0-2070-efc8-44e245f10c6f",
"B1": "3a14198c-c2d0-354f-39ad-642e1a72fcb8",
"B2": "3a14198c-c2d0-1559-105d-0ea30682cab4",
"B3": "3a14198c-c2d0-725e-523d-34c037ac2440",
"B4": "3a14198c-c2d0-efce-0939-69ca5a7dfd39"
}
}
}
# 物料类型配置
MATERIAL_TYPE_MAPPINGS = {
"烧杯": ("BIOYOND_PolymerStation_1FlaskCarrier", "3a14196b-24f2-ca49-9081-0cab8021bf1a"),
"试剂瓶": ("BIOYOND_PolymerStation_1BottleCarrier", ""),
"样品板": ("BIOYOND_PolymerStation_6StockCarrier", "3a14196e-b7a0-a5da-1931-35f3000281e9"),
"分装板": ("BIOYOND_PolymerStation_6VialCarrier", "3a14196e-5dfe-6e21-0c79-fe2036d052c4"),
"样品瓶": ("BIOYOND_PolymerStation_Solid_Stock", "3a14196a-cf7d-8aea-48d8-b9662c7dba94"),
"90%分装小瓶": ("BIOYOND_PolymerStation_Solid_Vial", "3a14196c-cdcf-088d-dc7d-5cf38f0ad9ea"),
"10%分装小瓶": ("BIOYOND_PolymerStation_Liquid_Vial", "3a14196c-76be-2279-4e22-7310d69aed68"),
}
# 步骤参数配置各工作流的步骤UUID
WORKFLOW_STEP_IDS = {
"reactor_taken_in": {
"config": ""
},
"liquid_feeding_beaker": {
"liquid": "",
"observe": ""
},
"liquid_feeding_vials_non_titration": {
"liquid": "",
"observe": ""
},
"liquid_feeding_solvents": {
"liquid": "",
"observe": ""
},
"solid_feeding_vials": {
"feeding": "",
"observe": ""
},
"liquid_feeding_titration": {
"liquid": "",
"observe": ""
},
"drip_back": {
"liquid": "",
"observe": ""
}
}
LOCATION_MAPPING = {}
ACTION_NAMES = {}
HTTP_SERVICE_CONFIG = {}

View File

@@ -0,0 +1,329 @@
# config.py
"""
Bioyond工作站配置文件
包含API配置、工作流映射、物料类型映射、仓库库位映射等所有配置信息
"""
from unilabos.resources.bioyond.decks import BIOYOND_PolymerReactionStation_Deck
# ============================================================================
# 基础配置
# ============================================================================
# API配置
API_CONFIG = {
"api_key": "DE9BDDA0",
"api_host": "http://192.168.1.200:44402"
}
# HTTP 报送服务配置
HTTP_SERVICE_CONFIG = {
"http_service_host": "127.0.0.1", # 监听地址
"http_service_port": 8080, # 监听端口
}
# Deck配置 - 反应站工作台配置
DECK_CONFIG = BIOYOND_PolymerReactionStation_Deck(setup=True)
# ============================================================================
# 工作流配置
# ============================================================================
# 工作流ID映射
WORKFLOW_MAPPINGS = {
"reactor_taken_out": "3a16081e-4788-ca37-eff4-ceed8d7019d1",
"reactor_taken_in": "3a160df6-76b3-0957-9eb0-cb496d5721c6",
"Solid_feeding_vials": "3a160877-87e7-7699-7bc6-ec72b05eb5e6",
"Liquid_feeding_vials(non-titration)": "3a167d99-6158-c6f0-15b5-eb030f7d8e47",
"Liquid_feeding_solvents": "3a160824-0665-01ed-285a-51ef817a9046",
"Liquid_feeding(titration)": "3a16082a-96ac-0449-446a-4ed39f3365b6",
"liquid_feeding_beaker": "3a16087e-124f-8ddb-8ec1-c2dff09ca784",
"Drip_back": "3a162cf9-6aac-565a-ddd7-682ba1796a4a",
}
# 工作流名称到显示名称的映射
WORKFLOW_TO_SECTION_MAP = {
'reactor_taken_in': '反应器放入',
'reactor_taken_out': '反应器取出',
'Solid_feeding_vials': '固体投料-小瓶',
'Liquid_feeding_vials(non-titration)': '液体投料-小瓶(非滴定)',
'Liquid_feeding_solvents': '液体投料-溶剂',
'Liquid_feeding(titration)': '液体投料-滴定',
'liquid_feeding_beaker': '液体投料-烧杯',
'Drip_back': '液体回滴'
}
# 工作流步骤ID配置
WORKFLOW_STEP_IDS = {
"reactor_taken_in": {
"config": "60a06f85-c5b3-29eb-180f-4f62dd7e2154"
},
"liquid_feeding_beaker": {
"liquid": "6808cda7-fee7-4092-97f0-5f9c2ffa60e3",
"observe": "1753c0de-dffc-4ee6-8458-805a2e227362"
},
"liquid_feeding_vials_non_titration": {
"liquid": "62ea6e95-3d5d-43db-bc1e-9a1802673861",
"observe": "3a167d99-6172-b67b-5f22-a7892197142e"
},
"liquid_feeding_solvents": {
"liquid": "1fcea355-2545-462b-b727-350b69a313bf",
"observe": "0553dfb3-9ac5-4ace-8e00-2f11029919a8"
},
"solid_feeding_vials": {
"feeding": "f7ae7448-4f20-4c1d-8096-df6fbadd787a",
"observe": "263c7ed5-7277-426b-bdff-d6fbf77bcc05"
},
"liquid_feeding_titration": {
"liquid": "a00ec41b-e666-4422-9c20-bfcd3cd15c54",
"observe": "ac738ff6-4c58-4155-87b1-d6f65a2c9ab5"
},
"drip_back": {
"liquid": "371be86a-ab77-4769-83e5-54580547c48a",
"observe": "ce024b9d-bd20-47b8-9f78-ca5ce7f44cf1"
}
}
# 工作流动作名称配置
ACTION_NAMES = {
"reactor_taken_in": {
"config": "通量-配置",
"stirring": "反应模块-开始搅拌"
},
"solid_feeding_vials": {
"feeding": "粉末加样模块-投料",
"observe": "反应模块-观察搅拌结果"
},
"liquid_feeding_vials_non_titration": {
"liquid": "稀释液瓶加液位-液体投料",
"observe": "反应模块-滴定结果观察"
},
"liquid_feeding_solvents": {
"liquid": "试剂AB放置位-试剂吸液分液",
"observe": "反应模块-观察搅拌结果"
},
"liquid_feeding_titration": {
"liquid": "稀释液瓶加液位-稀释液吸液分液",
"observe": "反应模块-滴定结果观察"
},
"liquid_feeding_beaker": {
"liquid": "烧杯溶液放置位-烧杯吸液分液",
"observe": "反应模块-观察搅拌结果"
},
"drip_back": {
"liquid": "试剂AB放置位-试剂吸液分液",
"observe": "反应模块-向下滴定结果观察"
}
}
# ============================================================================
# 仓库配置
# ============================================================================
# 说明:
# - 出库和入库操作都需要UUID
WAREHOUSE_MAPPING = {
# ========== 反应站仓库 ==========
# 堆栈1左 - 反应站左侧堆栈 (4行×4列=16个库位, A01D04)
"堆栈1左": {
"uuid": "3a14aa17-0d49-dce4-486e-4b5c85c8b366",
"site_uuids": {
"A01": "3a14aa17-0d49-11d7-a6e1-f236b3e5e5a3",
"A02": "3a14aa17-0d49-4bc5-8836-517b75473f5f",
"A03": "3a14aa17-0d49-c2bc-6222-5cee8d2d94f8",
"A04": "3a14aa17-0d49-3ce2-8e9a-008c38d116fb",
"B01": "3a14aa17-0d49-f49c-6b66-b27f185a3b32",
"B02": "3a14aa17-0d49-cf46-df85-a979c9c9920c",
"B03": "3a14aa17-0d49-7698-4a23-f7ffb7d48ba3",
"B04": "3a14aa17-0d49-1231-99be-d5870e6478e9",
"C01": "3a14aa17-0d49-be34-6fae-4aed9d48b70b",
"C02": "3a14aa17-0d49-11d7-0897-34921dcf6b7c",
"C03": "3a14aa17-0d49-9840-0bd5-9c63c1bb2c29",
"C04": "3a14aa17-0d49-8335-3bff-01da69ea4911",
"D01": "3a14aa17-0d49-2bea-c8e5-2b32094935d5",
"D02": "3a14aa17-0d49-cff4-e9e8-5f5f0bc1ef32",
"D03": "3a14aa17-0d49-4948-cb0a-78f30d1ca9b8",
"D04": "3a14aa17-0d49-fd2f-9dfb-a29b11e84099",
},
},
# 堆栈1右 - 反应站右侧堆栈 (4行×4列=16个库位, A05D08)
"堆栈1右": {
"uuid": "3a14aa17-0d49-dce4-486e-4b5c85c8b366",
"site_uuids": {
"A05": "3a14aa17-0d49-2c61-edc8-72a8ca7192dd",
"A06": "3a14aa17-0d49-60c8-2b00-40b17198f397",
"A07": "3a14aa17-0d49-ec5b-0b75-634dce8eed25",
"A08": "3a14aa17-0d49-3ec9-55b3-f3189c4ec53d",
"B05": "3a14aa17-0d49-6a4e-abcf-4c113eaaeaad",
"B06": "3a14aa17-0d49-e3f6-2dd6-28c2e8194fbe",
"B07": "3a14aa17-0d49-11a6-b861-ee895121bf52",
"B08": "3a14aa17-0d49-9c7d-1145-d554a6e482f0",
"C05": "3a14aa17-0d49-45c4-7a34-5105bc3e2368",
"C06": "3a14aa17-0d49-867e-39ab-31b3fe9014be",
"C07": "3a14aa17-0d49-ec56-c4b4-39fd9b2131e7",
"C08": "3a14aa17-0d49-1128-d7d9-ffb1231c98c0",
"D05": "3a14aa17-0d49-e843-f961-ea173326a14b",
"D06": "3a14aa17-0d49-4d26-a985-f188359c4f8b",
"D07": "3a14aa17-0d49-223a-b520-bc092bb42fe0",
"D08": "3a14aa17-0d49-4fa3-401a-6a444e1cca22",
},
},
# 站内试剂存放堆栈
"站内试剂存放堆栈": {
"uuid": "3a14aa3b-9fab-9d8e-d1a7-828f01f51f0c",
"site_uuids": {
"A01": "3a14aa3b-9fab-adac-7b9c-e1ee446b51d5",
"A02": "3a14aa3b-9fab-ca72-febc-b7c304476c78"
}
},
# 测量小瓶仓库(测密度)
"测量小瓶仓库": {
"uuid": "3a15012f-705b-c0de-3f9e-950c205f9921",
"site_uuids": {
"A01": "3a15012f-705e-0524-3161-c523b5aebc97",
"A02": "3a15012f-705e-7cd1-32ab-ad4fd1ab75c8",
"A03": "3a15012f-705e-a5d6-edac-bdbfec236260",
"B01": "3a15012f-705e-e0ee-80e0-10a6b3fc500d",
"B02": "3a15012f-705e-e499-180d-de06d60d0b21",
"B03": "3a15012f-705e-eff6-63f1-09f742096b26"
}
},
# 站内Tip盒堆栈 - 用于存放枪头盒 (耗材)
"站内Tip盒堆栈": {
"uuid": "3a14aa3a-2d3c-b5c1-9ddf-7c4a957d459a",
"site_uuids": {
"A01": "3a14aa3a-2d3d-e700-411a-0ddf85e1f18a",
"A02": "3a14aa3a-2d3d-a7ce-099a-d5632fdafa24",
"A03": "3a14aa3a-2d3d-bdf6-a702-c60b38b08501",
"B01": "3a14aa3a-2d3d-d704-f076-2a8d5bc72cb8",
"B02": "3a14aa3a-2d3d-c350-2526-0778d173a5ac",
"B03": "3a14aa3a-2d3d-bc38-b356-f0de2e44e0c7"
}
},
# ========== 配液站仓库 ==========
"粉末堆栈": {
"uuid": "3a14198e-6928-121f-7ca6-88ad3ae7e6a0",
"site_uuids": {
"A01": "3a14198e-6929-31f0-8a22-0f98f72260df",
"A02": "3a14198e-6929-4379-affa-9a2935c17f99",
"A03": "3a14198e-6929-56da-9a1c-7f5fbd4ae8af",
"A04": "3a14198e-6929-5e99-2b79-80720f7cfb54",
"B01": "3a14198e-6929-f525-9a1b-1857552b28ee",
"B02": "3a14198e-6929-bf98-0fd5-26e1d68bf62d",
"B03": "3a14198e-6929-2d86-a468-602175a2b5aa",
"B04": "3a14198e-6929-1a98-ae57-e97660c489ad",
"C01": "3a14198e-6929-46fe-841e-03dd753f1e4a",
"C02": "3a14198e-6929-72ac-32ce-9b50245682b8",
"C03": "3a14198e-6929-8a0b-b686-6f4a2955c4e2",
"C04": "3a14198e-6929-a0ec-5f15-c0f9f339f963",
"D01": "3a14198e-6929-1bc9-a9bd-3b7ca66e7f95",
"D02": "3a14198e-6929-3bd8-e6c7-4a9fd93be118",
"D03": "3a14198e-6929-dde1-fc78-34a84b71afdf",
"D04": "3a14198e-6929-7ac8-915a-fea51cb2e884"
}
},
"溶液堆栈": {
"uuid": "3a14198e-d723-2c13-7d12-50143e190a23",
"site_uuids": {
"A01": "3a14198e-d724-e036-afdc-2ae39a7f3383",
"A02": "3a14198e-d724-d818-6d4f-5725191a24b5",
"A03": "3a14198e-d724-b5bb-adf3-4c5a0da6fb31",
"A04": "3a14198e-d724-d378-d266-2508a224a19f",
"B01": "3a14198e-d724-afa4-fc82-0ac8a9016791",
"B02": "3a14198e-d724-be8a-5e0b-012675e195c6",
"B03": "3a14198e-d724-ab4e-48cb-817c3c146707",
"B04": "3a14198e-d724-f56e-468b-0110a8feb36a",
"C01": "3a14198e-d724-ca48-bb9e-7e85751e55b6",
"C02": "3a14198e-d724-cc1e-5c2c-228a130f40a8",
"C03": "3a14198e-d724-7f18-1853-39d0c62e1d33",
"C04": "3a14198e-d724-0cf1-dea9-a1f40fe7e13c",
"D01": "3a14198e-d724-df6d-5e32-5483b3cab583",
"D02": "3a14198e-d724-1e28-c885-574c3df468d0",
"D03": "3a14198e-d724-28a2-a760-baa896f46b66",
"D04": "3a14198e-d724-0ddd-9654-f9352a421de9"
}
},
"试剂堆栈": {
"uuid": "3a14198c-c2cc-0290-e086-44a428fba248",
"site_uuids": {
"A01": "3a14198c-c2cf-8b40-af28-b467808f1c36", # x=1, y=1, code=0001-0001
"A02": "3a14198c-c2d0-dc7d-b8d0-e1d88cee3094", # x=1, y=2, code=0001-0002
"A03": "3a14198c-c2d0-354f-39ad-642e1a72fcb8", # x=1, y=3, code=0001-0003
"A04": "3a14198c-c2d0-725e-523d-34c037ac2440", # x=1, y=4, code=0001-0004
"B01": "3a14198c-c2d0-f3e7-871a-e470d144296f", # x=2, y=1, code=0001-0005
"B02": "3a14198c-c2d0-2070-efc8-44e245f10c6f", # x=2, y=2, code=0001-0006
"B03": "3a14198c-c2d0-1559-105d-0ea30682cab4", # x=2, y=3, code=0001-0007
"B04": "3a14198c-c2d0-efce-0939-69ca5a7dfd39" # x=2, y=4, code=0001-0008
}
}
}
# ============================================================================
# 物料类型配置
# ============================================================================
# 说明:
# - 格式: PyLabRobot资源类型名称 → Bioyond系统typeId的UUID
# - 这个映射基于 resource.model 属性 (不是显示名称!)
# - UUID为空表示该类型暂未在Bioyond系统中定义
MATERIAL_TYPE_MAPPINGS = {
# ================================================配液站资源============================================================
# ==================================================样品===============================================================
"BIOYOND_PolymerStation_1FlaskCarrier": ("烧杯", "3a14196b-24f2-ca49-9081-0cab8021bf1a"), # 配液站-样品-烧杯
"BIOYOND_PolymerStation_1BottleCarrier": ("试剂瓶", "3a14196b-8bcf-a460-4f74-23f21ca79e72"), # 配液站-样品-试剂瓶
"BIOYOND_PolymerStation_6StockCarrier": ("分装板", "3a14196e-5dfe-6e21-0c79-fe2036d052c4"), # 配液站-样品-分装板
"BIOYOND_PolymerStation_Liquid_Vial": ("10%分装小瓶", "3a14196c-76be-2279-4e22-7310d69aed68"), # 配液站-样品-分装板-第一排小瓶
"BIOYOND_PolymerStation_Solid_Vial": ("90%分装小瓶", "3a14196c-cdcf-088d-dc7d-5cf38f0ad9ea"), # 配液站-样品-分装板-第二排小瓶
# ==================================================试剂===============================================================
"BIOYOND_PolymerStation_8StockCarrier": ("样品板", "3a14196e-b7a0-a5da-1931-35f3000281e9"), # 配液站-试剂-样品板8孔
"BIOYOND_PolymerStation_Solid_Stock": ("样品瓶", "3a14196a-cf7d-8aea-48d8-b9662c7dba94"), # 配液站-试剂-样品板-样品瓶
}
# ============================================================================
# 动态生成的库位UUID映射从WAREHOUSE_MAPPING中提取
# ============================================================================
LOCATION_MAPPING = {}
for warehouse_name, warehouse_config in WAREHOUSE_MAPPING.items():
if "site_uuids" in warehouse_config:
LOCATION_MAPPING.update(warehouse_config["site_uuids"])
# ============================================================================
# 物料默认参数配置
# ============================================================================
# 说明:
# - 为特定物料名称自动添加默认参数(如密度、分子量、单位等)
# - 格式: 物料名称 → {参数字典}
# - 在创建或更新物料时,会自动合并这些参数到 Parameters 字段
# - unit: 物料的计量单位(会用于 unit 字段)
# - density/densityUnit: 密度信息(会添加到 Parameters 中)
MATERIAL_DEFAULT_PARAMETERS = {
# 溶剂类
"NMP": {
"unit": "毫升",
"density": "1.03",
"densityUnit": "g/mL",
"description": "N-甲基吡咯烷酮 (N-Methyl-2-pyrrolidone)"
},
# 可以继续添加其他物料...
}
# ============================================================================
# 物料类型默认参数配置
# ============================================================================
# 说明:
# - 为特定物料类型UUID自动添加默认参数
# - 格式: Bioyond类型UUID → {参数字典}
# - 优先级低于按名称匹配的配置
MATERIAL_TYPE_PARAMETERS = {
# 示例:
# "3a14196b-24f2-ca49-9081-0cab8021bf1a": { # 烧杯
# "unit": "个"
# }
}

View File

@@ -4,7 +4,8 @@ import time
from typing import Optional, Dict, Any, List
from typing_extensions import TypedDict
import requests
from unilabos.devices.workstation.bioyond_studio.config import API_CONFIG
import pint
from unilabos.devices.workstation.bioyond_studio.bioyond_rpc import BioyondException
from unilabos.devices.workstation.bioyond_studio.station import BioyondWorkstation
@@ -25,13 +26,89 @@ class ComputeExperimentDesignReturn(TypedDict):
class BioyondDispensingStation(BioyondWorkstation):
def __init__(
self,
config,
# 桌子
deck,
*args,
config: dict = None,
deck=None,
protocol_type=None,
**kwargs,
):
super().__init__(config, deck, *args, **kwargs)
):
"""初始化配液站
Args:
config: 配置字典,应包含material_type_mappings等配置
deck: Deck对象
protocol_type: 协议类型(由ROS系统传递,此处忽略)
**kwargs: 其他可能的参数
"""
if config is None:
config = {}
# 将 kwargs 合并到 config 中 (处理扁平化配置如 api_key)
config.update(kwargs)
if deck is None and config:
deck = config.get('deck')
# 🔧 修复: 确保 Deck 上的 warehouses 具有正确的 UUID (必须在 super().__init__ 之前执行,因为父类会触发同步)
# 从配置中读取 warehouse_mapping并应用到实际的 deck 资源上
if config and "warehouse_mapping" in config and deck:
warehouse_mapping = config["warehouse_mapping"]
print(f"正在根据配置更新 Deck warehouse UUIDs... (共有 {len(warehouse_mapping)} 个配置)")
user_deck = deck
# 初始化 warehouses 字典
if not hasattr(user_deck, "warehouses") or user_deck.warehouses is None:
user_deck.warehouses = {}
# 1. 尝试从 children 中查找匹配的资源
for child in user_deck.children:
# 简单判断: 如果名字在 mapping 中,就认为是 warehouse
if child.name in warehouse_mapping:
user_deck.warehouses[child.name] = child
print(f" - 从子资源中找到 warehouse: {child.name}")
# 2. 如果还是没找到,且 Deck 类有 setup 方法,尝试调用 setup (针对 Deck 对象正确但未初始化的情况)
if not user_deck.warehouses and hasattr(user_deck, "setup"):
print(" - 尝试调用 deck.setup() 初始化仓库...")
try:
user_deck.setup()
# setup 后重新检查
if hasattr(user_deck, "warehouses") and user_deck.warehouses:
print(f" - setup() 成功,找到 {len(user_deck.warehouses)} 个仓库")
except Exception as e:
print(f" - 调用 setup() 失败: {e}")
# 3. 如果仍然为空,可能需要手动创建 (仅针对特定已知的 Deck 类型进行补救,这里暂时只打印警告)
if not user_deck.warehouses:
print(" - ⚠️ 仍然无法找到任何 warehouse 资源!")
for wh_name, wh_config in warehouse_mapping.items():
target_uuid = wh_config.get("uuid")
# 尝试在 deck.warehouses 中查找
wh_resource = None
if hasattr(user_deck, "warehouses") and wh_name in user_deck.warehouses:
wh_resource = user_deck.warehouses[wh_name]
# 如果没找到,尝试在所有子资源中查找
if not wh_resource:
wh_resource = user_deck.get_resource(wh_name)
if wh_resource:
if target_uuid:
current_uuid = getattr(wh_resource, "uuid", None)
print(f"✅ 更新仓库 '{wh_name}' UUID: {current_uuid} -> {target_uuid}")
# 动态添加 uuid 属性
wh_resource.uuid = target_uuid
# 同时也确保 category 正确,避免 graphio 识别错误
# wh_resource.category = "warehouse"
else:
print(f"⚠️ 仓库 '{wh_name}' 在配置中没有 UUID")
else:
print(f"❌ 在 Deck 中未找到配置的仓库: '{wh_name}'")
super().__init__(bioyond_config=config, deck=deck)
# self.config = config
# self.api_key = config["api_key"]
# self.host = config["api_host"]
@@ -43,6 +120,41 @@ class BioyondDispensingStation(BioyondWorkstation):
# 用于跟踪任务完成状态的字典: {orderCode: {status, order_id, timestamp}}
self.order_completion_status = {}
# 初始化 pint 单位注册表
self.ureg = pint.UnitRegistry()
# 化合物信息
self.compound_info = {
"MolWt": {
"MDA": 108.14 * self.ureg.g / self.ureg.mol,
"TDA": 122.16 * self.ureg.g / self.ureg.mol,
"PAPP": 521.62 * self.ureg.g / self.ureg.mol,
"BTDA": 322.23 * self.ureg.g / self.ureg.mol,
"BPDA": 294.22 * self.ureg.g / self.ureg.mol,
"6FAP": 366.26 * self.ureg.g / self.ureg.mol,
"PMDA": 218.12 * self.ureg.g / self.ureg.mol,
"MPDA": 108.14 * self.ureg.g / self.ureg.mol,
"SIDA": 248.51 * self.ureg.g / self.ureg.mol,
"ODA": 200.236 * self.ureg.g / self.ureg.mol,
"4,4'-ODA": 200.236 * self.ureg.g / self.ureg.mol,
"134": 292.34 * self.ureg.g / self.ureg.mol,
},
"FuncGroup": {
"MDA": "Amine",
"TDA": "Amine",
"PAPP": "Amine",
"BTDA": "Anhydride",
"BPDA": "Anhydride",
"6FAP": "Amine",
"MPDA": "Amine",
"SIDA": "Amine",
"PMDA": "Anhydride",
"ODA": "Amine",
"4,4'-ODA": "Amine",
"134": "Amine",
}
}
def _post_project_api(self, endpoint: str, data: Any) -> Dict[str, Any]:
"""项目接口通用POST调用
@@ -54,7 +166,7 @@ class BioyondDispensingStation(BioyondWorkstation):
dict: 服务端响应失败时返回 {code:0,message,...}
"""
request_data = {
"apiKey": API_CONFIG["api_key"],
"apiKey": self.bioyond_config["api_key"],
"requestTime": self.hardware_interface.get_current_time_iso8601(),
"data": data
}
@@ -85,7 +197,7 @@ class BioyondDispensingStation(BioyondWorkstation):
dict: 服务端响应失败时返回 {code:0,message,...}
"""
request_data = {
"apiKey": API_CONFIG["api_key"],
"apiKey": self.bioyond_config["api_key"],
"requestTime": self.hardware_interface.get_current_time_iso8601(),
"data": data
}
@@ -118,20 +230,22 @@ class BioyondDispensingStation(BioyondWorkstation):
ratio = json.loads(ratio)
except Exception:
ratio = {}
root = str(Path(__file__).resolve().parents[3])
if root not in sys.path:
sys.path.append(root)
try:
mod = importlib.import_module("tem.compute")
except Exception as e:
raise BioyondException(f"无法导入计算模块: {e}")
try:
wp = float(wt_percent) if isinstance(wt_percent, str) else wt_percent
mt = float(m_tot) if isinstance(m_tot, str) else m_tot
tp = float(titration_percent) if isinstance(titration_percent, str) else titration_percent
except Exception as e:
raise BioyondException(f"参数解析失败: {e}")
res = mod.generate_experiment_design(ratio=ratio, wt_percent=wp, m_tot=mt, titration_percent=tp)
# 2. 调用内部计算方法
res = self._generate_experiment_design(
ratio=ratio,
wt_percent=wp,
m_tot=mt,
titration_percent=tp
)
# 3. 构造返回结果
out = {
"solutions": res.get("solutions", []),
"titration": res.get("titration", {}),
@@ -140,11 +254,248 @@ class BioyondDispensingStation(BioyondWorkstation):
"return_info": json.dumps(res, ensure_ascii=False)
}
return out
except BioyondException:
raise
except Exception as e:
raise BioyondException(str(e))
def _generate_experiment_design(
self,
ratio: dict,
wt_percent: float = 0.25,
m_tot: float = 70,
titration_percent: float = 0.03,
) -> dict:
"""内部方法:生成实验设计
根据FuncGroup自动区分二胺和二酐每种二胺单独配溶液严格按照ratio顺序投料
参数:
ratio: 化合物配比字典格式: {"compound_name": ratio_value}
wt_percent: 固体重量百分比
m_tot: 反应混合物总质量(g)
titration_percent: 滴定溶液百分比
返回:
包含实验设计详细参数的字典
"""
# 溶剂密度
ρ_solvent = 1.03 * self.ureg.g / self.ureg.ml
# 二酐溶解度
solubility = 0.02 * self.ureg.g / self.ureg.ml
# 投入固体时最小溶剂体积
V_min = 30 * self.ureg.ml
m_tot = m_tot * self.ureg.g
# 保持ratio中的顺序
compound_names = list(ratio.keys())
compound_ratios = list(ratio.values())
# 验证所有化合物是否在 compound_info 中定义
undefined_compounds = [name for name in compound_names if name not in self.compound_info["MolWt"]]
if undefined_compounds:
available = list(self.compound_info["MolWt"].keys())
raise ValueError(
f"以下化合物未在 compound_info 中定义: {undefined_compounds}"
f"可用的化合物: {available}"
)
# 获取各化合物的分子量和官能团类型
molecular_weights = [self.compound_info["MolWt"][name] for name in compound_names]
func_groups = [self.compound_info["FuncGroup"][name] for name in compound_names]
# 记录化合物信息用于调试
self.hardware_interface._logger.info(f"化合物名称: {compound_names}")
self.hardware_interface._logger.info(f"官能团类型: {func_groups}")
# 按原始顺序分离二胺和二酐
ordered_compounds = list(zip(compound_names, compound_ratios, molecular_weights, func_groups))
diamine_compounds = [(name, ratio_val, mw, i) for i, (name, ratio_val, mw, fg) in enumerate(ordered_compounds) if fg == "Amine"]
anhydride_compounds = [(name, ratio_val, mw, i) for i, (name, ratio_val, mw, fg) in enumerate(ordered_compounds) if fg == "Anhydride"]
if not diamine_compounds or not anhydride_compounds:
raise ValueError(
f"需要同时包含二胺(Amine)和二酐(Anhydride)化合物。"
f"当前二胺: {[c[0] for c in diamine_compounds]}, "
f"当前二酐: {[c[0] for c in anhydride_compounds]}"
)
# 计算加权平均分子量 (基于摩尔比)
total_molar_ratio = sum(compound_ratios)
weighted_molecular_weight = sum(ratio_val * mw for ratio_val, mw in zip(compound_ratios, molecular_weights))
# 取最后一个二酐用于滴定
titration_anhydride = anhydride_compounds[-1]
solid_anhydrides = anhydride_compounds[:-1] if len(anhydride_compounds) > 1 else []
# 二胺溶液配制参数 - 每种二胺单独配制
diamine_solutions = []
total_diamine_volume = 0 * self.ureg.ml
# 计算反应物的总摩尔量
n_reactant = m_tot * wt_percent / weighted_molecular_weight
for name, ratio_val, mw, order_index in diamine_compounds:
# 跳过 SIDA
if name == "SIDA":
continue
# 计算该二胺需要的摩尔数
n_diamine_needed = n_reactant * ratio_val
# 二胺溶液配制参数 (每种二胺固定配制参数)
m_diamine_solid = 5.0 * self.ureg.g # 每种二胺固体质量
V_solvent_for_this = 20 * self.ureg.ml # 每种二胺溶剂体积
m_solvent_for_this = ρ_solvent * V_solvent_for_this
# 计算该二胺溶液的浓度
c_diamine = (m_diamine_solid / mw) / V_solvent_for_this
# 计算需要移取的溶液体积
V_diamine_needed = n_diamine_needed / c_diamine
diamine_solutions.append({
"name": name,
"order": order_index,
"solid_mass": m_diamine_solid.magnitude,
"solvent_volume": V_solvent_for_this.magnitude,
"concentration": c_diamine.magnitude,
"volume_needed": V_diamine_needed.magnitude,
"molar_ratio": ratio_val
})
total_diamine_volume += V_diamine_needed
# 按原始顺序排序
diamine_solutions.sort(key=lambda x: x["order"])
# 计算滴定二酐的质量
titration_name, titration_ratio, titration_mw, _ = titration_anhydride
m_titration_anhydride = n_reactant * titration_ratio * titration_mw
m_titration_90 = m_titration_anhydride * (1 - titration_percent)
m_titration_10 = m_titration_anhydride * titration_percent
# 计算其他固体二酐的质量 (按顺序)
solid_anhydride_masses = []
for name, ratio_val, mw, order_index in solid_anhydrides:
mass = n_reactant * ratio_val * mw
solid_anhydride_masses.append({
"name": name,
"order": order_index,
"mass": mass.magnitude,
"molar_ratio": ratio_val
})
# 按原始顺序排序
solid_anhydride_masses.sort(key=lambda x: x["order"])
# 计算溶剂用量
total_diamine_solution_mass = sum(
sol["volume_needed"] * ρ_solvent for sol in diamine_solutions
) * self.ureg.ml
# 预估滴定溶剂量、计算补加溶剂量
m_solvent_titration = m_titration_10 / solubility * ρ_solvent
m_solvent_add = m_tot * (1 - wt_percent) - total_diamine_solution_mass - m_solvent_titration
# 检查最小溶剂体积要求
total_liquid_volume = (total_diamine_solution_mass + m_solvent_add) / ρ_solvent
m_tot_min = V_min / total_liquid_volume * m_tot
# 如果需要,按比例放大
scale_factor = 1.0
if m_tot_min > m_tot:
scale_factor = (m_tot_min / m_tot).magnitude
m_titration_90 *= scale_factor
m_titration_10 *= scale_factor
m_solvent_add *= scale_factor
m_solvent_titration *= scale_factor
# 更新二胺溶液用量
for sol in diamine_solutions:
sol["volume_needed"] *= scale_factor
# 更新固体二酐用量
for anhydride in solid_anhydride_masses:
anhydride["mass"] *= scale_factor
m_tot = m_tot_min
# 生成投料顺序
feeding_order = []
# 1. 固体二酐 (按顺序)
for anhydride in solid_anhydride_masses:
feeding_order.append({
"step": len(feeding_order) + 1,
"type": "solid_anhydride",
"name": anhydride["name"],
"amount": anhydride["mass"],
"order": anhydride["order"]
})
# 2. 二胺溶液 (按顺序)
for sol in diamine_solutions:
feeding_order.append({
"step": len(feeding_order) + 1,
"type": "diamine_solution",
"name": sol["name"],
"amount": sol["volume_needed"],
"order": sol["order"]
})
# 3. 主要二酐粉末
feeding_order.append({
"step": len(feeding_order) + 1,
"type": "main_anhydride",
"name": titration_name,
"amount": m_titration_90.magnitude,
"order": titration_anhydride[3]
})
# 4. 补加溶剂
if m_solvent_add > 0:
feeding_order.append({
"step": len(feeding_order) + 1,
"type": "additional_solvent",
"name": "溶剂",
"amount": m_solvent_add.magnitude,
"order": 999
})
# 5. 滴定二酐溶液
feeding_order.append({
"step": len(feeding_order) + 1,
"type": "titration_anhydride",
"name": f"{titration_name} 滴定液",
"amount": m_titration_10.magnitude,
"titration_solvent": m_solvent_titration.magnitude,
"order": titration_anhydride[3]
})
# 返回实验设计结果
results = {
"total_mass": m_tot.magnitude,
"scale_factor": scale_factor,
"solutions": diamine_solutions,
"solids": solid_anhydride_masses,
"titration": {
"name": titration_name,
"main_portion": m_titration_90.magnitude,
"titration_portion": m_titration_10.magnitude,
"titration_solvent": m_solvent_titration.magnitude,
},
"solvents": {
"additional_solvent": m_solvent_add.magnitude,
"total_liquid_volume": total_liquid_volume.magnitude
},
"feeding_order": feeding_order,
"minimum_required_mass": m_tot_min.magnitude
}
return results
# 90%10%小瓶投料任务创建方法
def create_90_10_vial_feeding_task(self,
order_name: str = None,
@@ -961,6 +1312,108 @@ class BioyondDispensingStation(BioyondWorkstation):
'actualVolume': actual_volume
}
def _simplify_report(self, report) -> Dict[str, Any]:
"""简化实验报告,只保留关键信息,去除冗余的工作流参数"""
if not isinstance(report, dict):
return report
data = report.get('data', {})
if not isinstance(data, dict):
return report
# 提取关键信息
simplified = {
'name': data.get('name'),
'code': data.get('code'),
'requester': data.get('requester'),
'workflowName': data.get('workflowName'),
'workflowStep': data.get('workflowStep'),
'requestTime': data.get('requestTime'),
'startPreparationTime': data.get('startPreparationTime'),
'completeTime': data.get('completeTime'),
'useTime': data.get('useTime'),
'status': data.get('status'),
'statusName': data.get('statusName'),
}
# 提取物料信息(简化版)
pre_intakes = data.get('preIntakes', [])
if pre_intakes and isinstance(pre_intakes, list):
first_intake = pre_intakes[0]
sample_materials = first_intake.get('sampleMaterials', [])
# 简化物料信息
simplified_materials = []
for material in sample_materials:
if isinstance(material, dict):
mat_info = {
'materialName': material.get('materialName'),
'materialTypeName': material.get('materialTypeName'),
'materialCode': material.get('materialCode'),
'materialLocation': material.get('materialLocation'),
}
# 解析parameters中的关键信息如密度、加料历史等
params_str = material.get('parameters', '{}')
try:
params = json.loads(params_str) if isinstance(params_str, str) else params_str
if isinstance(params, dict):
# 只保留关键参数
if 'density' in params:
mat_info['density'] = params['density']
if 'feedingHistory' in params:
mat_info['feedingHistory'] = params['feedingHistory']
if 'liquidVolume' in params:
mat_info['liquidVolume'] = params['liquidVolume']
if 'm_diamine_tot' in params:
mat_info['m_diamine_tot'] = params['m_diamine_tot']
if 'wt_diamine' in params:
mat_info['wt_diamine'] = params['wt_diamine']
except:
pass
simplified_materials.append(mat_info)
simplified['sampleMaterials'] = simplified_materials
# 提取extraProperties中的实际值
extra_props = first_intake.get('extraProperties', {})
if isinstance(extra_props, dict):
simplified_extra = {}
for key, value in extra_props.items():
try:
parsed_value = json.loads(value) if isinstance(value, str) else value
simplified_extra[key] = parsed_value
except:
simplified_extra[key] = value
simplified['extraProperties'] = simplified_extra
return {
'data': simplified,
'code': report.get('code'),
'message': report.get('message'),
'timestamp': report.get('timestamp')
}
def scheduler_start(self) -> dict:
"""启动调度器 - 启动Bioyond工作站的任务调度器开始执行队列中的任务
Returns:
dict: 包含return_info的字典return_info为整型(1=成功)
Raises:
BioyondException: 调度器启动失败时抛出异常
"""
result = self.hardware_interface.scheduler_start()
self.hardware_interface._logger.info(f"调度器启动结果: {result}")
if result != 1:
error_msg = "启动调度器失败: 有未处理错误调度无法启动。请检查Bioyond系统状态。"
self.hardware_interface._logger.error(error_msg)
raise BioyondException(error_msg)
return {"return_info": result}
# 等待多个任务完成并获取实验报告
def wait_for_multiple_orders_and_get_reports(self,
batch_create_result: str = None,
@@ -1002,7 +1455,12 @@ class BioyondDispensingStation(BioyondWorkstation):
# 验证batch_create_result参数
if not batch_create_result or batch_create_result == "":
raise BioyondException("batch_create_result参数为空请确保从batch_create节点正确连接handle")
raise BioyondException(
"batch_create_result参数为空请确保:\n"
"1. batch_create节点与wait节点之间正确连接了handle\n"
"2. batch_create节点成功执行并返回了结果\n"
"3. 检查上游batch_create任务是否成功创建了订单"
)
# 解析batch_create_result JSON对象
try:
@@ -1031,7 +1489,17 @@ class BioyondDispensingStation(BioyondWorkstation):
# 验证提取的数据
if not order_codes:
raise BioyondException("batch_create_result中未找到order_codes字段或为空")
self.hardware_interface._logger.error(
f"batch_create任务未生成任何订单。batch_create_result内容: {batch_create_result}"
)
raise BioyondException(
"batch_create_result中未找到order_codes或为空。\n"
"可能的原因:\n"
"1. batch_create任务执行失败检查任务是否报错\n"
"2. 物料配置问题(如'物料样品板分配失败'\n"
"3. Bioyond系统状态异常\n"
f"请检查batch_create任务的执行结果"
)
if not order_ids:
raise BioyondException("batch_create_result中未找到order_ids字段或为空")
@@ -1114,6 +1582,8 @@ class BioyondDispensingStation(BioyondWorkstation):
self.hardware_interface._logger.info(
f"成功获取任务 {order_code} 的实验报告"
)
# 简化报告,去除冗余信息
report = self._simplify_report(report)
reports.append({
"order_code": order_code,
@@ -1288,7 +1758,7 @@ class BioyondDispensingStation(BioyondWorkstation):
f"开始执行批量物料转移: {len(transfer_groups)}组任务 -> {target_device_id}"
)
from .config import WAREHOUSE_MAPPING
warehouse_mapping = self.bioyond_config.get("warehouse_mapping", {})
results = []
successful_count = 0
failed_count = 0

View File

@@ -6,6 +6,7 @@ Bioyond Workstation Implementation
"""
import time
import traceback
import threading
from datetime import datetime
from typing import Dict, Any, List, Optional, Union
import json
@@ -23,12 +24,94 @@ from unilabos.ros.nodes.presets.workstation import ROS2WorkstationNode
from unilabos.ros.msgs.message_converter import convert_to_ros_msg, Float64, String
from pylabrobot.resources.resource import Resource as ResourcePLR
from unilabos.devices.workstation.bioyond_studio.config import (
API_CONFIG, WORKFLOW_MAPPINGS, MATERIAL_TYPE_MAPPINGS, WAREHOUSE_MAPPING, HTTP_SERVICE_CONFIG
)
from unilabos.devices.workstation.workstation_http_service import WorkstationHTTPService
class ConnectionMonitor:
"""Bioyond连接监控器"""
def __init__(self, workstation, check_interval=30):
self.workstation = workstation
self.check_interval = check_interval
self._running = False
self._thread = None
self._last_status = "unknown"
def start(self):
if self._running:
return
self._running = True
self._thread = threading.Thread(target=self._monitor_loop, daemon=True, name="BioyondConnectionMonitor")
self._thread.start()
logger.info("Bioyond连接监控器已启动")
def stop(self):
self._running = False
if self._thread:
self._thread.join(timeout=2)
logger.info("Bioyond连接监控器已停止")
def _monitor_loop(self):
while self._running:
try:
# 使用 lightweight API 检查连接
# query_matial_type_list 是比较快的查询
start_time = time.time()
result = self.workstation.hardware_interface.material_type_list()
status = "online" if result else "offline"
msg = "Connection established" if status == "online" else "Failed to get material type list"
if status != self._last_status:
logger.info(f"Bioyond连接状态变更: {self._last_status} -> {status}")
self._publish_event(status, msg)
self._last_status = status
# 发布心跳 (可选,或者只在状态变更时发布)
# self._publish_event(status, msg)
except Exception as e:
logger.error(f"Bioyond连接检查异常: {e}")
if self._last_status != "error":
self._publish_event("error", str(e))
self._last_status = "error"
time.sleep(self.check_interval)
def _publish_event(self, status, message):
try:
if hasattr(self.workstation, "_ros_node") and self.workstation._ros_node:
event_data = {
"status": status,
"message": message,
"timestamp": datetime.now().isoformat()
}
# 动态发布消息,需要在 ROS2DeviceNode 中有对应支持
# 这里假设通用事件发布机制,使用 String 类型的 topic
# 话题: /<namespace>/events/device_status
ns = self.workstation._ros_node.namespace
topic = f"{ns}/events/device_status"
# 使用 ROS2DeviceNode 的发布功能
# 如果没有预定义的 publisher需要动态创建
# 注意workstation base node 可能没有自动创建 arbitrary publishers 的机制
# 这里我们先尝试用 String json 发布
# 在 ROS2DeviceNode 中通常需要先 create_publisher
# 为了简单起见,我们检查是否已有 publisher没有则创建
if not hasattr(self.workstation, "_device_status_pub"):
self.workstation._device_status_pub = self.workstation._ros_node.create_publisher(
String, topic, 10
)
self.workstation._device_status_pub.publish(
convert_to_ros_msg(String, json.dumps(event_data, ensure_ascii=False))
)
except Exception as e:
logger.error(f"发布设备状态事件失败: {e}")
class BioyondResourceSynchronizer(ResourceSynchronizer):
"""Bioyond资源同步器
@@ -174,9 +257,8 @@ class BioyondResourceSynchronizer(ResourceSynchronizer):
else:
logger.info(f"[同步→Bioyond] 物料不存在于 Bioyond将创建新物料并入库")
# 第1步获取仓库配置
from .config import WAREHOUSE_MAPPING
warehouse_mapping = WAREHOUSE_MAPPING
# 第1步从配置中获取仓库配置
warehouse_mapping = self.bioyond_config.get("warehouse_mapping", {})
# 确定目标仓库名称
parent_name = None
@@ -238,14 +320,20 @@ class BioyondResourceSynchronizer(ResourceSynchronizer):
# 第2步转换为 Bioyond 格式
logger.info(f"[同步→Bioyond] 🔄 转换物料为 Bioyond 格式...")
# 导入物料默认参数配置
from .config import MATERIAL_DEFAULT_PARAMETERS
# 从配置中获取物料默认参数
material_default_params = self.workstation.bioyond_config.get("material_default_parameters", {})
material_type_params = self.workstation.bioyond_config.get("material_type_parameters", {})
# 合并参数配置:物料名称参数 + typeId参数转换为 type:<uuid> 格式)
merged_params = material_default_params.copy()
for type_id, params in material_type_params.items():
merged_params[f"type:{type_id}"] = params
bioyond_material = resource_plr_to_bioyond(
[resource],
type_mapping=self.workstation.bioyond_config["material_type_mappings"],
warehouse_mapping=self.workstation.bioyond_config["warehouse_mapping"],
material_params=MATERIAL_DEFAULT_PARAMETERS
material_params=merged_params
)[0]
logger.info(f"[同步→Bioyond] 🔧 准备覆盖locations字段目标仓库: {parent_name}, 库位: {update_site}, UUID: {target_location_uuid[:8]}...")
@@ -468,13 +556,20 @@ class BioyondResourceSynchronizer(ResourceSynchronizer):
return material_bioyond_id
# 转换为 Bioyond 格式
from .config import MATERIAL_DEFAULT_PARAMETERS
# 从配置中获取物料默认参数
material_default_params = self.workstation.bioyond_config.get("material_default_parameters", {})
material_type_params = self.workstation.bioyond_config.get("material_type_parameters", {})
# 合并参数配置:物料名称参数 + typeId参数转换为 type:<uuid> 格式)
merged_params = material_default_params.copy()
for type_id, params in material_type_params.items():
merged_params[f"type:{type_id}"] = params
bioyond_material = resource_plr_to_bioyond(
[resource],
type_mapping=self.workstation.bioyond_config["material_type_mappings"],
warehouse_mapping=self.workstation.bioyond_config["warehouse_mapping"],
material_params=MATERIAL_DEFAULT_PARAMETERS
material_params=merged_params
)[0]
# ⚠️ 关键:创建物料时不设置 locations让 Bioyond 系统暂不分配库位
@@ -528,8 +623,7 @@ class BioyondResourceSynchronizer(ResourceSynchronizer):
logger.info(f"[物料入库] 目标库位: {update_site}")
# 获取仓库配置和目标库位 UUID
from .config import WAREHOUSE_MAPPING
warehouse_mapping = WAREHOUSE_MAPPING
warehouse_mapping = self.workstation.bioyond_config.get("warehouse_mapping", {})
parent_name = None
target_location_uuid = None
@@ -584,6 +678,44 @@ class BioyondWorkstation(WorkstationBase):
集成Bioyond物料管理的工作站实现
"""
def _publish_task_status(
self,
task_id: str,
task_type: str,
status: str,
result: dict = None,
progress: float = 0.0,
task_code: str = None
):
"""发布任务状态事件"""
try:
if not getattr(self, "_ros_node", None):
return
event_data = {
"task_id": task_id,
"task_code": task_code,
"task_type": task_type,
"status": status,
"progress": progress,
"timestamp": datetime.now().isoformat()
}
if result:
event_data["result"] = result
topic = f"{self._ros_node.namespace}/events/task_status"
if not hasattr(self, "_task_status_pub"):
self._task_status_pub = self._ros_node.create_publisher(
String, topic, 10
)
self._task_status_pub.publish(
convert_to_ros_msg(String, json.dumps(event_data, ensure_ascii=False))
)
except Exception as e:
logger.error(f"发布任务状态事件失败: {e}")
def __init__(
self,
bioyond_config: Optional[Dict[str, Any]] = None,
@@ -605,10 +737,28 @@ class BioyondWorkstation(WorkstationBase):
raise ValueError("Deck 配置不能为空,请在配置文件中添加正确的 deck 配置")
# 初始化 warehouses 属性
self.deck.warehouses = {}
for resource in self.deck.children:
if isinstance(resource, WareHouse):
self.deck.warehouses[resource.name] = resource
if not hasattr(self.deck, "warehouses") or self.deck.warehouses is None:
self.deck.warehouses = {}
# 仅当 warehouses 为空时尝试重新扫描(避免覆盖子类的修复)
if not self.deck.warehouses:
for resource in self.deck.children:
# 兼容性增强: 只要是仓库类别或者是 WareHouse 实例均可
is_warehouse = isinstance(resource, WareHouse) or getattr(resource, "category", "") == "warehouse"
# 如果配置中有定义,也可以认定为 warehouse
if not is_warehouse and "warehouse_mapping" in bioyond_config:
if resource.name in bioyond_config["warehouse_mapping"]:
is_warehouse = True
if is_warehouse:
self.deck.warehouses[resource.name] = resource
# 确保 category 被正确设置,方便后续使用
if getattr(resource, "category", "") != "warehouse":
try:
resource.category = "warehouse"
except:
pass
# 创建通信模块
self._create_communication_module(bioyond_config)
@@ -627,18 +777,22 @@ class BioyondWorkstation(WorkstationBase):
self._set_workflow_mappings(bioyond_config["workflow_mappings"])
# 准备 HTTP 报送接收服务配置(延迟到 post_init 启动)
# 从 bioyond_config 中获取,如果没有则使用 HTTP_SERVICE_CONFIG 的默认值
# 从 bioyond_config 中的 http_service_config 获取
http_service_cfg = bioyond_config.get("http_service_config", {})
self._http_service_config = {
"host": bioyond_config.get("http_service_host", HTTP_SERVICE_CONFIG["http_service_host"]),
"port": bioyond_config.get("http_service_port", HTTP_SERVICE_CONFIG["http_service_port"])
"host": http_service_cfg.get("http_service_host", "127.0.0.1"),
"port": http_service_cfg.get("http_service_port", 8080)
}
self.http_service = None # 将在 post_init 启动
self.http_service = None # 将在 post_init 启动
self.connection_monitor = None # 将在 post_init 启动
logger.info(f"Bioyond工作站初始化完成")
def __del__(self):
"""析构函数:清理资源,停止 HTTP 服务"""
try:
if hasattr(self, 'connection_monitor') and self.connection_monitor:
self.connection_monitor.stop()
if hasattr(self, 'http_service') and self.http_service is not None:
logger.info("正在停止 HTTP 报送服务...")
self.http_service.stop()
@@ -648,8 +802,19 @@ class BioyondWorkstation(WorkstationBase):
def post_init(self, ros_node: ROS2WorkstationNode):
self._ros_node = ros_node
# 启动连接监控
try:
self.connection_monitor = ConnectionMonitor(self)
self.connection_monitor.start()
except Exception as e:
logger.error(f"启动连接监控失败: {e}")
# 启动 HTTP 报送接收服务(现在 device_id 已可用)
if hasattr(self, '_http_service_config'):
# ⚠️ 检查子类是否已经自己管理 HTTP 服务
if self.bioyond_config.get("_disable_auto_http_service"):
logger.info("🔧 检测到 _disable_auto_http_service 标志,跳过自动启动 HTTP 服务")
logger.info(" 子类BioyondCellWorkstation已自行管理 HTTP 服务")
elif hasattr(self, '_http_service_config'):
try:
self.http_service = WorkstationHTTPService(
workstation_instance=self,
@@ -688,19 +853,14 @@ class BioyondWorkstation(WorkstationBase):
def _create_communication_module(self, config: Optional[Dict[str, Any]] = None) -> None:
"""创建Bioyond通信模块"""
# 创建默认配置
default_config = {
**API_CONFIG,
"workflow_mappings": WORKFLOW_MAPPINGS,
"material_type_mappings": MATERIAL_TYPE_MAPPINGS,
"warehouse_mapping": WAREHOUSE_MAPPING
}
# 如果传入了 config合并配置config 中的值会覆盖默认值)
# 直接使用传入的配置,不再使用默认值
# 所有配置必须从 JSON 文件中提供
if config:
self.bioyond_config = {**default_config, **config}
self.bioyond_config = config
else:
self.bioyond_config = default_config
# 如果没有配置,使用空字典(会导致后续错误,但这是预期的)
self.bioyond_config = {}
print("警告: 未提供 bioyond_config请确保在 JSON 配置文件中提供完整配置")
self.hardware_interface = BioyondV1RPC(self.bioyond_config)
@@ -1014,7 +1174,15 @@ class BioyondWorkstation(WorkstationBase):
workflow_id = self._get_workflow(actual_workflow_name)
if workflow_id:
self.workflow_sequence.append(workflow_id)
# 兼容 BioyondReactionStation 中 workflow_sequence 被重写为 property 的情况
if isinstance(self.workflow_sequence, list):
self.workflow_sequence.append(workflow_id)
elif hasattr(self, "_cached_workflow_sequence") and isinstance(self._cached_workflow_sequence, list):
self._cached_workflow_sequence.append(workflow_id)
else:
print(f"❌ 无法添加工作流: workflow_sequence 类型错误 {type(self.workflow_sequence)}")
return False
print(f"添加工作流到执行顺序: {actual_workflow_name} -> {workflow_id}")
return True
return False
@@ -1215,6 +1383,22 @@ class BioyondWorkstation(WorkstationBase):
# TODO: 根据实际业务需求处理步骤完成逻辑
# 例如:更新数据库、触发后续流程等
# 发布任务状态事件 (running/progress update)
self._publish_task_status(
task_id=data.get('orderCode'), # 使用 OrderCode 作为关联 ID
task_code=data.get('orderCode'),
task_type="bioyond_step",
status="running",
progress=0.5, # 步骤完成视为任务进行中
result={"step_name": data.get('stepName'), "step_id": data.get('stepId')}
)
# 更新物料信息
# 步骤完成后,物料状态可能发生变化(如位置、用量等),触发同步
logger.info(f"[步骤完成报送] 触发物料同步...")
self.resource_synchronizer.sync_from_external()
return {
"processed": True,
"step_id": data.get('stepId'),
@@ -1249,6 +1433,17 @@ class BioyondWorkstation(WorkstationBase):
# TODO: 根据实际业务需求处理通量完成逻辑
# 发布任务状态事件
self._publish_task_status(
task_id=data.get('orderCode'),
task_code=data.get('orderCode'),
task_type="bioyond_sample",
status="running",
progress=0.7,
result={"sample_id": data.get('sampleId'), "status": status_desc}
)
return {
"processed": True,
"sample_id": data.get('sampleId'),
@@ -1288,6 +1483,32 @@ class BioyondWorkstation(WorkstationBase):
# TODO: 根据实际业务需求处理任务完成逻辑
# 例如:更新物料库存、生成报表等
# 映射状态到事件状态
event_status = "completed"
if str(data.get('status')) in ["-11", "-12"]:
event_status = "error"
elif str(data.get('status')) == "30":
event_status = "completed"
else:
event_status = "running" # 其他状态视为运行中(或根据实际定义)
# 发布任务状态事件
self._publish_task_status(
task_id=data.get('orderCode'),
task_code=data.get('orderCode'),
task_type="bioyond_order",
status=event_status,
progress=1.0 if event_status in ["completed", "error"] else 0.9,
result={"order_name": data.get('orderName'), "status": status_desc, "materials_count": len(used_materials)}
)
# 更新物料信息
# 任务完成后,且状态为完成时,触发同步以更新最终物料状态
if event_status == "completed":
logger.info(f"[任务完成报送] 触发物料同步...")
self.resource_synchronizer.sync_from_external()
return {
"processed": True,
"order_code": data.get('orderCode'),

View File

@@ -0,0 +1,84 @@
# Modbus CSV 地址映射说明
本文档说明 `coin_cell_assembly_a.csv` 文件如何将命名节点映射到实际的 Modbus 地址,以及如何在代码中使用它们。
## 1. CSV 文件结构
地址表文件位于同级目录下:`coin_cell_assembly_a.csv`
每一行定义了一个 Modbus 节点,包含以下关键列:
| 列名 | 说明 | 示例 |
|------|------|------|
| **Name** | **节点名称** (代码中引用的 Key) | `COIL_ALUMINUM_FOIL` |
| **DataType** | 数据类型 (BOOL, INT16, FLOAT32, STRING) | `BOOL` |
| **Comment** | 注释说明 | `使用铝箔垫` |
| **Attribute** | 属性 (通常留空或用于额外标记) | |
| **DeviceType** | Modbus 寄存器类型 (`coil`, `hold_register`) | `coil` |
| **Address** | **Modbus 地址** (十进制) | `8340` |
### 示例行 (铝箔垫片)
```csv
COIL_ALUMINUM_FOIL,BOOL,,使用铝箔垫,,coil,8340,
```
- **名称**: `COIL_ALUMINUM_FOIL`
- **类型**: `coil` (线圈,读写单个位)
- **地址**: `8340`
---
## 2. 加载与注册流程
`coin_cell_assembly.py` 的初始化代码中:
1. **加载 CSV**: `BaseClient.load_csv()` 读取 CSV 并解析每行定义。
2. **注册节点**: `modbus_client.register_node_list()` 将解析后的节点注册到 Modbus 客户端实例中。
```python
# 代码位置: coin_cell_assembly.py (L174-175)
self.nodes = BaseClient.load_csv(os.path.join(os.path.dirname(__file__), 'coin_cell_assembly_a.csv'))
self.client = modbus_client.register_node_list(self.nodes)
```
---
## 3. 代码中的使用方式
注册后,通过 `self.client.use_node('节点名称')` 即可获取该节点对象并进行读写操作,无需关心具体地址。
### 控制铝箔垫片 (COIL_ALUMINUM_FOIL)
```python
# 代码位置: qiming_coin_cell_code 函数 (L1048)
self.client.use_node('COIL_ALUMINUM_FOIL').write(not lvbodian)
```
- **写入 True**: 对应 Modbus 功能码 05 (Write Single Coil),向地址 `8340` 写入 `1` (ON)。
- **写入 False**: 向地址 `8340` 写入 `0` (OFF)。
> **注意**: 代码中使用了 `not lvbodian`,这意味着逻辑是反转的。如果 `lvbodian` 参数为 `True` (默认),写入的是 `False` (不使用铝箔垫)。
---
## 4. 地址转换注意事项 (Modbus vs PLC)
CSV 中的 `Address` 列(如 `8340`)是 **Modbus 协议地址**
如果使用 InoProShop (汇川 PLC 编程软件),看到的可能是 **PLC 内部地址** (如 `%QX...``%MW...`)。这两者之间通常需要转换。
### 常见的转换规则 (示例)
- **Coil (线圈) %QX**:
- `Modbus地址 = 字节地址 * 8 + 位偏移`
- *例子*: `%QX834.0` -> `834 * 8 + 0` = `6672`
- *注意*: 如果 CSV 中配置的是 `8340`,这可能是一个自定义映射,或者是基于不同规则(如直接对应 Word 地址的某种映射,或者可能就是地址写错了/使用了非标准映射)。
- **Register (寄存器) %MW**:
- 通常直接对应,或者有偏移量 (如 Modbus 40001 = PLC MW0)。
### 验证方法
由于 `test_unilab_interact.py` 中发现 `8450` (CSV风格) 不工作,而 `6760` (%QX845.0 计算值) 工作正常,**建议对 CSV 中的其他地址也进行核实**,特别是像 `8340` 这样以 0 结尾看起来像是 "字节地址+0" 的数值,可能实际上应该是 `%QX834.0` 对应的 `6672`
如果发现设备控制无反应,请尝试按照标准的 Modbus 计算方式转换 PLC 地址。

View File

@@ -0,0 +1,352 @@
# 2026-01-13 物料搜寻确认弹窗自动处理功能
## 概述
本次更新为设备初始化流程添加了**物料搜寻确认弹窗自动检测与处理功能**。在设备初始化过程中PLC 会弹出物料搜寻确认对话框,现在系统可以根据用户参数自动点击"是"或"否"按钮,无需手动干预。
## 背景问题
### 原有流程
1. 调用 `func_pack_device_init_auto_start_combined()` 初始化设备
2. PLC 在初始化过程中弹出物料搜寻确认对话框
3. **需要人工手动点击**"是"或"否"按钮
4. PLC 继续完成初始化并启动
### 存在的问题
- 需要人工干预,无法实现全自动化
- 影响批量生产效率
- 容易遗忘点击导致流程卡住
## 解决方案
### 新增 Modbus 地址配置
`coin_cell_assembly_b.csv` 第 69-71 行添加三个 coil
| Name | DeviceType | Address | 说明 |
|------|-----------|---------|------|
| COIL_MATERIAL_SEARCH_DIALOG_APPEAR | coil | 6470 | 物料搜寻确认弹窗画面是否出现 |
| COIL_MATERIAL_SEARCH_CONFIRM_YES | coil | 6480 | 初始化物料搜寻确认按钮"是" |
| COIL_MATERIAL_SEARCH_CONFIRM_NO | coil | 6490 | 初始化物料搜寻确认按钮"否" |
**Modbus 地址转换:**
- CSV 6470 → Modbus 5176 (弹窗出现)
- CSV 6480 → Modbus 5184 (按钮"是")
- CSV 6490 → Modbus 5192 (按钮"否")
## 代码修改详情
### 1. coin_cell_assembly.py
#### 1.1 新增辅助方法 `_handle_material_search_dialog()`
**位置:** 第 799-901 行
**功能:**
- 监测物料搜寻确认弹窗是否出现Coil 5176
- 根据 `enable_search` 参数自动点击对应按钮
- 使用**脉冲模式**模拟真实按钮操作:`True` → 保持 0.5 秒 → `False`
**参数:**
- `enable_search: bool` - True=点击"是"(启用物料搜寻), False=点击"否"(不启用)
- `timeout: int = 30` - 等待弹窗出现的最大时间(秒)
**逻辑流程:**
```python
1. 监测 COIL_MATERIAL_SEARCH_DIALOG_APPEAR ( 0.5 秒检查一次)
2. 检测到弹窗出现 (Coil = True)
3. 选择按钮
- enable_search=True COIL_MATERIAL_SEARCH_CONFIRM_YES
- enable_search=False COIL_MATERIAL_SEARCH_CONFIRM_NO
4. 执行脉冲操作
- 写入 True (按下按钮)
- 等待 0.5
- 写入 False (释放按钮)
- 验证状态
```
#### 1.2 修改 `func_pack_device_init_auto_start_combined()`
**位置:** 第 904-1115 行
**主要改动:**
1. **添加新参数**
```python
def func_pack_device_init_auto_start_combined(
self,
material_search_enable: bool = False # 新增参数
) -> bool:
```
2. **内联初始化逻辑并集成弹窗检测**
- 不再调用 `self.func_pack_device_init()`
- 将初始化逻辑直接实现在函数内
- **在等待初始化完成的循环中实时检测弹窗**
- 避免死锁PLC 等待弹窗确认 ↔ 代码等待初始化完成
3. **关键代码片段**
```python
# 等待初始化完成,同时检测物料搜寻弹窗
while (self._sys_init_status()) == False:
# 检查超时
if time.time() - start_wait > max_wait_time:
raise RuntimeError(f"初始化超时")
# 如果还没处理弹窗,检测弹窗是否出现
if not dialog_handled:
dialog_state = self.client.use_node('COIL_MATERIAL_SEARCH_DIALOG_APPEAR').read(1)
if dialog_actual: # 弹窗出现
# 执行脉冲按钮点击
button_node.write(True) # 按下
time.sleep(0.5) # 保持
button_node.write(False) # 释放
dialog_handled = True
time.sleep(1)
```
4. **步骤调整**
- 步骤 0: 前置条件检查
- 步骤 1: 设备初始化(**包含弹窗检测**
- 步骤 1.5: 已在步骤 1 中完成
- 步骤 2: 切换自动模式
- 步骤 3: 启动设备
### 2. coin_cell_workstation.yaml
**位置:** 第 292-312 行
**修改内容:**
```yaml
auto-func_pack_device_init_auto_start_combined:
goal_default:
material_search_enable: false # 新增默认值
schema:
description: 组合函数:设备初始化 + 物料搜寻确认 + 切换自动模式 + 启动。初始化过程中会自动检测物料搜寻确认弹窗,并根据参数自动点击"是"或"否"按钮
goal:
properties:
material_search_enable: # 新增参数配置
default: false
description: 是否启用物料搜寻功能。设备初始化后会弹出物料搜寻确认弹窗,此参数控制自动点击"是"(启用)或"否"(不启用)。默认为false(不启用物料搜寻)
type: boolean
```
### 3. 测试脚本(已创建,用户已删除)
#### 3.1 test_material_search_dialog.py
- 从 CSV 动态加载 Modbus 地址
- 支持 4 种测试模式:
- `query` - 查询所有状态
- `dialog <0|1>` - 设置弹窗出现/消失
- `yes` - 脉冲点击"是"按钮
- `no` - 脉冲点击"否"按钮
- 兼容 pymodbus 3.x API
#### 3.2 更新其他测试脚本
- `test_coin_cell_reset.py` - 更新为 pymodbus 3.x API
- `test_unilab_interact.py` - 更新为 pymodbus 3.x API
## 使用方法
### 参数说明
| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `material_search_enable` | boolean | `false` | 是否启用物料搜寻功能 |
### 调用示例
#### 1. 不启用物料搜寻(默认)
```python
# 默认参数,点击"否"按钮
await device.func_pack_device_init_auto_start_combined()
```
或在 YAML workflow 中:
```yaml
# 使用默认值 false不启用物料搜寻
- BatteryStation/auto-func_pack_device_init_auto_start_combined: {}
```
#### 2. 启用物料搜寻
```python
# 显式设置为 True点击"是"按钮
await device.func_pack_device_init_auto_start_combined(
material_search_enable=True
)
```
或在 YAML workflow 中:
```yaml
- BatteryStation/auto-func_pack_device_init_auto_start_combined:
goal:
material_search_enable: true # 启用物料搜寻
```
## 执行日志示例
```
26-01-13 [21:32:44] [INFO] 开始组合操作:设备初始化 → 物料搜寻确认 → 自动模式 → 启动
26-01-13 [21:32:44] [INFO] 【步骤 0/4】前置条件检查...
26-01-13 [21:32:44] [INFO] ✓ REG_UNILAB_INTERACT 检查通过
26-01-13 [21:32:44] [INFO] ✓ COIL_GB_L_IGNORE_CMD 检查通过
26-01-13 [21:32:44] [INFO] 【步骤 1/4】设备初始化...
26-01-13 [21:32:44] [INFO] 切换手动模式...
26-01-13 [21:32:46] [INFO] 发送初始化命令...
26-01-13 [21:32:47] [INFO] 等待初始化完成(同时监测物料搜寻弹窗)...
26-01-13 [21:33:05] [INFO] ✓ 在初始化过程中检测到物料搜寻确认弹窗!
26-01-13 [21:33:05] [INFO] 用户选择: 不启用物料搜寻(点击否)
26-01-13 [21:33:05] [INFO] → 按下按钮 '否'
26-01-13 [21:33:06] [INFO] → 释放按钮 '否'
26-01-13 [21:33:07] [INFO] ✓ 成功处理物料搜寻确认弹窗(选择: 否)
26-01-13 [21:33:08] [INFO] ✓ 初始化状态完成
26-01-13 [21:33:12] [INFO] ✓ 设备初始化完成
26-01-13 [21:33:12] [INFO] 【步骤 1.5/4】物料搜寻确认已在初始化过程中完成
26-01-13 [21:33:12] [INFO] 【步骤 2/4】切换自动模式...
26-01-13 [21:33:15] [INFO] ✓ 切换自动模式完成
26-01-13 [21:33:15] [INFO] 【步骤 3/4】启动设备...
26-01-13 [21:33:18] [INFO] ✓ 启动设备完成
26-01-13 [21:33:18] [INFO] 组合操作完成:设备已成功初始化、确认物料搜寻、切换自动模式并启动
```
## 技术要点
### 1. 脉冲模式按钮操作
模拟真实按钮按压过程:
1. 写入 `True` (按下)
2. 保持 0.5 秒
3. 写入 `False` (释放)
4. 验证状态
### 2. 避免死锁
**问题:** PLC 在初始化过程中等待弹窗确认,而代码等待初始化完成
**解决:** 在初始化等待循环中实时检测弹窗,一旦出现立即处理
### 3. 超时保护
- 弹窗检测超时30 秒(在 `_handle_material_search_dialog` 中)
- 初始化超时120 秒(在 `func_pack_device_init_auto_start_combined` 中)
### 4. PyModbus 3.x API 兼容
所有 Modbus 操作使用 keyword arguments
```python
# 读取
client.read_coils(address=5176, count=1)
# 写入
client.write_coil(address=5184, value=True)
```
## 向后兼容性
### 保留的原有函数
- `func_pack_device_init()` - 单独的初始化函数,不包含弹窗处理
- 仍可在 YAML 中通过 `auto-func_pack_device_init` 调用
- 用于不需要自动处理弹窗的场景
### 新增的功能
- 在 `func_pack_device_init_auto_start_combined()` 中集成弹窗处理
- 通过参数控制,默认行为与之前兼容(点击"否"
## 验证测试
### 测试场景
#### 场景 1默认参数不启用物料搜寻
```bash
# 调用时不传参数
BatteryStation/auto-func_pack_device_init_auto_start_combined: {}
```
**预期结果:**
- ✅ 检测到弹窗
- ✅ 自动点击"否"按钮
- ✅ 初始化完成并启动成功
#### 场景 2启用物料搜寻
```bash
# 设置 material_search_enable=true
BatteryStation/auto-func_pack_device_init_auto_start_combined:
goal:
material_search_enable: true
```
**预期结果:**
- ✅ 检测到弹窗
- ✅ 自动点击"是"按钮
- ✅ 初始化完成并启动成功
### 实际测试结果
**测试时间:** 2026-01-13 21:32:43
**测试参数:** `material_search_enable: false`
**测试结果:** ✅ 成功
**关键时间节点:**
- 21:33:05 - 检测到弹窗
- 21:33:05 - 按下"否"按钮
- 21:33:06 - 释放"否"按钮
- 21:33:07 - 弹窗处理完成
- 21:33:08 - 初始化状态完成
- 21:33:18 - 整个流程完成
**总耗时:** 约 35 秒(包含初始化全过程)
## 注意事项
1. **CSV 配置依赖**
- 确保 `coin_cell_assembly_b.csv` 包含 69-71 行的 coil 配置
- 地址转换逻辑:`modbus_addr = (csv_addr // 10) * 8 + (csv_addr % 10)`
2. **默认行为**
- 默认 `material_search_enable=false`,即不启用物料搜寻
- 如需启用,必须显式设置为 `true`
3. **日志级别**
- 弹窗检测过程中的 `waiting for init_cmd` 使用 DEBUG 级别
- 关键操作(检测到弹窗、按钮操作)使用 INFO 级别
4. **原有函数保留**
- `func_pack_device_init()` 仍然可用,但不包含弹窗处理
- 如果单独调用此函数,仍需手动处理弹窗
## 文件清单
### 修改的文件
1. `d:\UniLabdev\Uni-Lab-OS\unilabos\devices\workstation\coin_cell_assembly\coin_cell_assembly.py`
- 新增 `_handle_material_search_dialog()` 方法
- 修改 `func_pack_device_init_auto_start_combined()` 函数
2. `d:\UniLabdev\Uni-Lab-OS\unilabos\registry\devices\coin_cell_workstation.yaml`
- 更新 `auto-func_pack_device_init_auto_start_combined` 配置
- 添加 `material_search_enable` 参数说明
3. `d:\UniLabdev\Uni-Lab-OS\unilabos\devices\workstation\coin_cell_assembly\coin_cell_assembly_b.csv`
- 第 69-71 行添加三个 coil 配置
### 创建的测试文件(已删除)
1. `test_material_search_dialog.py` - 物料搜寻弹窗测试脚本
2. `test_coin_cell_reset.py` - 复位功能测试(更新为 pymodbus 3.x
3. `test_unilab_interact.py` - Unilab 交互测试(更新为 pymodbus 3.x
## 总结
本次更新成功实现了设备初始化过程中物料搜寻确认弹窗的自动化处理,主要优势:
**全自动化** - 无需人工干预
**参数可配** - 灵活控制是否启用物料搜寻
**实时检测** - 在初始化等待循环中检测,避免死锁
**脉冲模式** - 模拟真实按钮操作
**向后兼容** - 保留原有函数,不影响现有流程
**完整日志** - 详细记录每一步操作
**超时保护** - 防止无限等待
该功能已通过实际测试验证,可投入生产使用。
---
**文档版本:** 1.0
**创建日期:** 2026-01-13
**作者:** Antigravity AI Assistant
**最后更新:** 2026-01-13 21:36

View File

@@ -0,0 +1,645 @@
"""
纽扣电池组装工作站物料类定义
Button Battery Assembly Station Resource Classes
"""
from __future__ import annotations
from collections import OrderedDict
from typing import Any, Dict, List, Optional, TypedDict, Union, cast
from pylabrobot.resources.coordinate import Coordinate
from pylabrobot.resources.container import Container
from pylabrobot.resources.deck import Deck
from pylabrobot.resources.itemized_resource import ItemizedResource
from pylabrobot.resources.resource import Resource
from pylabrobot.resources.resource_stack import ResourceStack
from pylabrobot.resources.tip_rack import TipRack, TipSpot
from pylabrobot.resources.trash import Trash
from pylabrobot.resources.utils import create_ordered_items_2d
from unilabos.resources.battery.magazine import MagazineHolder_4_Cathode, MagazineHolder_6_Cathode, MagazineHolder_6_Anode, MagazineHolder_6_Battery
from unilabos.resources.battery.bottle_carriers import YIHUA_Electrolyte_12VialCarrier
from unilabos.resources.battery.electrode_sheet import ElectrodeSheet
# TODO: 这个应该只能放一个极片
class MaterialHoleState(TypedDict):
diameter: int
depth: int
max_sheets: int
info: Optional[str] # 附加信息
class MaterialHole(Resource):
"""料板洞位类"""
children: List[ElectrodeSheet] = []
def __init__(
self,
name: str,
size_x: float,
size_y: float,
size_z: float,
category: str = "material_hole",
**kwargs
):
super().__init__(
name=name,
size_x=size_x,
size_y=size_y,
size_z=size_z,
category=category,
)
self._unilabos_state: MaterialHoleState = MaterialHoleState(
diameter=20,
depth=10,
max_sheets=1,
info=None
)
def get_all_sheet_info(self):
info_list = []
for sheet in self.children:
info_list.append(sheet._unilabos_state["info"])
return info_list
#这个函数函数好像没用,一般不会集中赋值质量
def set_all_sheet_mass(self):
for sheet in self.children:
sheet._unilabos_state["mass"] = 0.5 # 示例设置质量为0.5g
def load_state(self, state: Dict[str, Any]) -> None:
"""格式不变"""
super().load_state(state)
self._unilabos_state = state
def serialize_state(self) -> Dict[str, Dict[str, Any]]:
"""格式不变"""
data = super().serialize_state()
data.update(self._unilabos_state) # Container自身的信息云端物料将保存这一data本地也通过这里的data进行读写当前类用来表示这个物料的长宽高大小的属性而datastate用来表示物料的内容细节等
return data
#移动极片前先取出对象
def get_sheet_with_name(self, name: str) -> Optional[ElectrodeSheet]:
for sheet in self.children:
if sheet.name == name:
return sheet
return None
def has_electrode_sheet(self) -> bool:
"""检查洞位是否有极片"""
return len(self.children) > 0
def assign_child_resource(
self,
resource: ElectrodeSheet,
location: Optional[Coordinate],
reassign: bool = True,
):
"""放置极片"""
# TODO: 这里要改diameter找不到加入._unilabos_state后应该没问题
#if resource._unilabos_state["diameter"] > self._unilabos_state["diameter"]:
# raise ValueError(f"极片直径 {resource._unilabos_state['diameter']} 超过洞位直径 {self._unilabos_state['diameter']}")
#if len(self.children) >= self._unilabos_state["max_sheets"]:
# raise ValueError(f"洞位已满,无法放置更多极片")
super().assign_child_resource(resource, location, reassign)
# 根据children的编号取物料对象。
def get_electrode_sheet_info(self, index: int) -> ElectrodeSheet:
return self.children[index]
class MaterialPlateState(TypedDict):
hole_spacing_x: float
hole_spacing_y: float
hole_diameter: float
info: Optional[str] # 附加信息
class MaterialPlate(ItemizedResource[MaterialHole]):
"""料板类 - 4x4个洞位每个洞位放1个极片"""
children: List[MaterialHole]
def __init__(
self,
name: str,
size_x: float,
size_y: float,
size_z: float,
ordered_items: Optional[Dict[str, MaterialHole]] = None,
ordering: Optional[OrderedDict[str, str]] = None,
category: str = "material_plate",
model: Optional[str] = None,
fill: bool = False
):
"""初始化料板
Args:
name: 料板名称
size_x: 长度 (mm)
size_y: 宽度 (mm)
size_z: 高度 (mm)
hole_diameter: 洞直径 (mm)
hole_depth: 洞深度 (mm)
hole_spacing_x: X方向洞位间距 (mm)
hole_spacing_y: Y方向洞位间距 (mm)
number: 编号
category: 类别
model: 型号
"""
self._unilabos_state: MaterialPlateState = MaterialPlateState(
hole_spacing_x=24.0,
hole_spacing_y=24.0,
hole_diameter=20.0,
info="",
)
# 创建4x4的洞位
# TODO: 这里要改,对应不同形状
holes = create_ordered_items_2d(
klass=MaterialHole,
num_items_x=4,
num_items_y=4,
dx=(size_x - 4 * self._unilabos_state["hole_spacing_x"]) / 2, # 居中
dy=(size_y - 4 * self._unilabos_state["hole_spacing_y"]) / 2, # 居中
dz=size_z,
item_dx=self._unilabos_state["hole_spacing_x"],
item_dy=self._unilabos_state["hole_spacing_y"],
size_x = 16,
size_y = 16,
size_z = 16,
)
if fill:
super().__init__(
name=name,
size_x=size_x,
size_y=size_y,
size_z=size_z,
ordered_items=holes,
category=category,
model=model,
)
else:
super().__init__(
name=name,
size_x=size_x,
size_y=size_y,
size_z=size_z,
ordered_items=ordered_items,
ordering=ordering,
category=category,
model=model,
)
def update_locations(self):
# TODO:调多次相加
holes = create_ordered_items_2d(
klass=MaterialHole,
num_items_x=4,
num_items_y=4,
dx=(self._size_x - 3 * self._unilabos_state["hole_spacing_x"]) / 2, # 居中
dy=(self._size_y - 3 * self._unilabos_state["hole_spacing_y"]) / 2, # 居中
dz=self._size_z,
item_dx=self._unilabos_state["hole_spacing_x"],
item_dy=self._unilabos_state["hole_spacing_y"],
size_x = 1,
size_y = 1,
size_z = 1,
)
for item, original_item in zip(holes.items(), self.children):
original_item.location = item[1].location
class PlateSlot(ResourceStack):
"""板槽位类 - 1个槽上能堆放8个板移板只能操作最上方的板"""
def __init__(
self,
name: str,
size_x: float,
size_y: float,
size_z: float,
max_plates: int = 8,
category: str = "plate_slot",
model: Optional[str] = None
):
"""初始化板槽位
Args:
name: 槽位名称
max_plates: 最大板数量
category: 类别
"""
super().__init__(
name=name,
direction="z", # Z方向堆叠
resources=[],
)
self.max_plates = max_plates
self.category = category
def can_add_plate(self) -> bool:
"""检查是否可以添加板"""
return len(self.children) < self.max_plates
def add_plate(self, plate: MaterialPlate) -> None:
"""添加料板"""
if not self.can_add_plate():
raise ValueError(f"槽位 {self.name} 已满,无法添加更多板")
self.assign_child_resource(plate)
def get_top_plate(self) -> MaterialPlate:
"""获取最上方的板"""
if len(self.children) == 0:
raise ValueError(f"槽位 {self.name} 为空")
return cast(MaterialPlate, self.get_top_item())
def take_top_plate(self) -> MaterialPlate:
"""取出最上方的板"""
top_plate = self.get_top_plate()
self.unassign_child_resource(top_plate)
return top_plate
def can_access_for_picking(self) -> bool:
"""检查是否可以进行取料操作(只有最上方的板能进行取料操作)"""
return len(self.children) > 0
def serialize(self) -> dict:
return {
**super().serialize(),
"max_plates": self.max_plates,
}
#是一种类型注解不用self
class BatteryState(TypedDict):
"""电池状态字典"""
diameter: float
height: float
assembly_pressure: float
electrolyte_volume: float
electrolyte_name: str
class Battery(Resource):
"""电池类 - 可容纳极片"""
children: List[ElectrodeSheet] = []
def __init__(
self,
name: str,
size_x=1,
size_y=1,
size_z=1,
category: str = "battery",
):
"""初始化电池
Args:
name: 电池名称
diameter: 直径 (mm)
height: 高度 (mm)
max_volume: 最大容量 (μL)
barcode: 二维码编号
category: 类别
model: 型号
"""
super().__init__(
name=name,
size_x=1,
size_y=1,
size_z=1,
category=category,
)
self._unilabos_state: BatteryState = BatteryState(
diameter = 1.0,
height = 1.0,
assembly_pressure = 1.0,
electrolyte_volume = 1.0,
electrolyte_name = "DP001"
)
def add_electrolyte_with_bottle(self, bottle: Bottle) -> bool:
to_add_name = bottle._unilabos_state["electrolyte_name"]
if bottle.aspirate_electrolyte(10):
if self.add_electrolyte(to_add_name, 10):
pass
else:
bottle._unilabos_state["electrolyte_volume"] += 10
def set_electrolyte(self, name: str, volume: float) -> None:
"""设置电解液信息"""
self._unilabos_state["electrolyte_name"] = name
self._unilabos_state["electrolyte_volume"] = volume
#这个应该没用,不会有加了后再加的事情
def add_electrolyte(self, name: str, volume: float) -> bool:
"""添加电解液信息"""
if name != self._unilabos_state["electrolyte_name"]:
return False
self._unilabos_state["electrolyte_volume"] += volume
def load_state(self, state: Dict[str, Any]) -> None:
"""格式不变"""
super().load_state(state)
self._unilabos_state = state
def serialize_state(self) -> Dict[str, Dict[str, Any]]:
"""格式不变"""
data = super().serialize_state()
data.update(self._unilabos_state) # Container自身的信息云端物料将保存这一data本地也通过这里的data进行读写当前类用来表示这个物料的长宽高大小的属性而datastate用来表示物料的内容细节等
return data
# 电解液作为属性放进去
class BatteryPressSlotState(TypedDict):
"""电池状态字典"""
diameter: float =20.0
depth: float = 4.0
class BatteryPressSlot(Resource):
"""电池压制槽类 - 设备,可容纳一个电池"""
children: List[Battery] = []
def __init__(
self,
name: str = "BatteryPressSlot",
category: str = "battery_press_slot",
):
"""初始化电池压制槽
Args:
name: 压制槽名称
diameter: 直径 (mm)
depth: 深度 (mm)
category: 类别
model: 型号
"""
super().__init__(
name=name,
size_x=10,
size_y=12,
size_z=13,
category=category,
)
self._unilabos_state: BatteryPressSlotState = BatteryPressSlotState()
def has_battery(self) -> bool:
"""检查是否有电池"""
return len(self.children) > 0
def load_state(self, state: Dict[str, Any]) -> None:
"""格式不变"""
super().load_state(state)
self._unilabos_state = state
def serialize_state(self) -> Dict[str, Dict[str, Any]]:
"""格式不变"""
data = super().serialize_state()
data.update(self._unilabos_state) # Container自身的信息云端物料将保存这一data本地也通过这里的data进行读写当前类用来表示这个物料的长宽高大小的属性而datastate用来表示物料的内容细节等
return data
def assign_child_resource(
self,
resource: Battery,
location: Optional[Coordinate],
reassign: bool = True,
):
"""放置极片"""
# TODO: 让高京看下槽位只有一个电池时是否这么写。
if self.has_battery():
raise ValueError(f"槽位已含有一个电池,无法再放置其他电池")
super().assign_child_resource(resource, location, reassign)
# 根据children的编号取物料对象。
def get_battery_info(self, index: int) -> Battery:
return self.children[0]
def TipBox64(
name: str,
size_x: float = 127.8,
size_y: float = 85.5,
size_z: float = 60.0,
category: str = "tip_rack",
model: Optional[str] = None,
):
"""64孔枪头盒类"""
from pylabrobot.resources.tip import Tip
# 创建12x8=96个枪头位
def make_tip():
return Tip(
has_filter=False,
total_tip_length=20.0,
maximal_volume=1000, # 1mL
fitting_depth=8.0,
)
tip_spots = create_ordered_items_2d(
klass=TipSpot,
num_items_x=12,
num_items_y=8,
dx=8.0,
dy=8.0,
dz=0.0,
item_dx=9.0,
item_dy=9.0,
size_x=10,
size_y=10,
size_z=0.0,
make_tip=make_tip,
)
idx_available = list(range(0, 32)) + list(range(64, 96))
tip_spots_available = {k: v for i, (k, v) in enumerate(tip_spots.items()) if i in idx_available}
tip_rack = TipRack(
name=name,
size_x=size_x,
size_y=size_y,
size_z=size_z,
# ordered_items=tip_spots_available,
ordered_items=tip_spots,
category=category,
model=model,
with_tips=False,
)
tip_rack.set_tip_state([True]*32 + [False]*32 + [True]*32) # 前32和后32个有枪头中间32个无枪头
return tip_rack
class WasteTipBoxstate(TypedDict):
""""废枪头盒状态字典"""
max_tips: int = 100
tip_count: int = 0
#枪头不是一次性的(同一溶液则反复使用),根据寄存器判断
class WasteTipBox(Trash):
"""废枪头盒类 - 100个枪头容量"""
def __init__(
self,
name: str,
size_x: float = 127.8,
size_y: float = 85.5,
size_z: float = 60.0,
material_z_thickness=0,
max_volume=float("inf"),
category="trash",
model=None,
compute_volume_from_height=None,
compute_height_from_volume=None,
):
"""初始化废枪头盒
Args:
name: 废枪头盒名称
size_x: 长度 (mm)
size_y: 宽度 (mm)
size_z: 高度 (mm)
max_tips: 最大枪头容量
category: 类别
model: 型号
"""
super().__init__(
name=name,
size_x=size_x,
size_y=size_y,
size_z=size_z,
category=category,
model=model,
)
self._unilabos_state: WasteTipBoxstate = WasteTipBoxstate()
def add_tip(self) -> None:
"""添加废枪头"""
if self._unilabos_state["tip_count"] >= self._unilabos_state["max_tips"]:
raise ValueError(f"废枪头盒 {self.name} 已满")
self._unilabos_state["tip_count"] += 1
def get_tip_count(self) -> int:
"""获取枪头数量"""
return self._unilabos_state["tip_count"]
def empty(self) -> None:
"""清空废枪头盒"""
self._unilabos_state["tip_count"] = 0
def load_state(self, state: Dict[str, Any]) -> None:
"""格式不变"""
super().load_state(state)
self._unilabos_state = state
def serialize_state(self) -> Dict[str, Dict[str, Any]]:
"""格式不变"""
data = super().serialize_state()
data.update(self._unilabos_state) # Container自身的信息云端物料将保存这一data本地也通过这里的data进行读写当前类用来表示这个物料的长宽高大小的属性而datastate用来表示物料的内容细节等
return data
class CoincellDeck(Deck):
"""纽扣电池组装工作站台面类"""
def __init__(
self,
name: str = "coin_cell_deck",
size_x: float = 1450.0, # 1m
size_y: float = 1450.0, # 1m
size_z: float = 100.0, # 0.9m
origin: Coordinate = Coordinate(-2200, 0, 0),
category: str = "coin_cell_deck",
setup: bool = False, # 是否自动执行 setup
):
"""初始化纽扣电池组装工作站台面
Args:
name: 台面名称
size_x: 长度 (mm) - 1m
size_y: 宽度 (mm) - 1m
size_z: 高度 (mm) - 0.9m
origin: 原点坐标
category: 类别
setup: 是否自动执行 setup 配置标准布局
"""
super().__init__(
name=name,
size_x=1450.0,
size_y=1450.0,
size_z=100.0,
origin=origin,
)
if setup:
self.setup()
def setup(self) -> None:
"""设置工作站的标准布局 - 包含子弹夹、料盘、瓶架等完整配置"""
# ====================================== 子弹夹 ============================================
# 正极片4个洞位2x2布局
zhengji_zip = MagazineHolder_4_Cathode("正极&铝箔弹夹")
self.assign_child_resource(zhengji_zip, Coordinate(x=402.0, y=830.0, z=0))
# 正极壳、平垫片6个洞位2x2+2布局
zhengjike_zip = MagazineHolder_6_Cathode("正极壳&平垫片弹夹")
self.assign_child_resource(zhengjike_zip, Coordinate(x=566.0, y=272.0, z=0))
# 负极壳、弹垫片6个洞位2x2+2布局
fujike_zip = MagazineHolder_6_Anode("负极壳&弹垫片弹夹")
self.assign_child_resource(fujike_zip, Coordinate(x=474.0, y=276.0, z=0))
# 成品弹夹6个洞位3x2布局
chengpindanjia_zip = MagazineHolder_6_Battery("成品弹夹")
self.assign_child_resource(chengpindanjia_zip, Coordinate(x=260.0, y=156.0, z=0))
# ====================================== 物料板 ============================================
# 创建物料板料盘carrier- 4x4布局
# 负极料盘
fujiliaopan = MaterialPlate(name="负极料盘", size_x=120, size_y=100, size_z=10.0, fill=True)
self.assign_child_resource(fujiliaopan, Coordinate(x=708.0, y=794.0, z=0))
# for i in range(16):
# fujipian = ElectrodeSheet(name=f"{fujiliaopan.name}_jipian_{i}", size_x=12, size_y=12, size_z=0.1)
# fujiliaopan.children[i].assign_child_resource(fujipian, location=None)
# 隔膜料盘
gemoliaopan = MaterialPlate(name="隔膜料盘", size_x=120, size_y=100, size_z=10.0, fill=True)
self.assign_child_resource(gemoliaopan, Coordinate(x=718.0, y=918.0, z=0))
# for i in range(16):
# gemopian = ElectrodeSheet(name=f"{gemoliaopan.name}_jipian_{i}", size_x=12, size_y=12, size_z=0.1)
# gemoliaopan.children[i].assign_child_resource(gemopian, location=None)
# ====================================== 瓶架、移液枪 ============================================
# 在台面上放置 3x4 瓶架、6x2 瓶架 与 64孔移液枪头盒
# 奔耀上料5ml分液瓶小板 - 由奔曜跨站转运而来,不单独写,但是这里应该有一个堆栈用于摆放分液瓶小板
# bottle_rack_3x4 = BottleRack(
# name="bottle_rack_3x4",
# size_x=210.0,
# size_y=140.0,
# size_z=100.0,
# num_items_x=2,
# num_items_y=4,
# position_spacing=35.0,
# orientation="vertical",
# )
# self.assign_child_resource(bottle_rack_3x4, Coordinate(x=1542.0, y=717.0, z=0))
# 电解液缓存位 - 6x2布局
bottle_rack_6x2 = YIHUA_Electrolyte_12VialCarrier(name="bottle_rack_6x2")
self.assign_child_resource(bottle_rack_6x2, Coordinate(x=1050.0, y=358.0, z=0))
# 电解液回收位6x2
bottle_rack_6x2_2 = YIHUA_Electrolyte_12VialCarrier(name="bottle_rack_6x2_2")
self.assign_child_resource(bottle_rack_6x2_2, Coordinate(x=914.0, y=358.0, z=0))
tip_box = TipBox64(name="tip_box_64")
self.assign_child_resource(tip_box, Coordinate(x=782.0, y=514.0, z=0))
waste_tip_box = WasteTipBox(name="waste_tip_box")
self.assign_child_resource(waste_tip_box, Coordinate(x=778.0, y=622.0, z=0))
def YH_Deck(name=""):
cd = CoincellDeck(name=name)
cd.setup()
return cd
if __name__ == "__main__":
deck = create_coin_cell_deck()
print(deck)

View File

@@ -0,0 +1,133 @@
Name,DataType,InitValue,Comment,Attribute,DeviceType,Address,
COIL_SYS_START_CMD,BOOL,,,,coil,8010,
COIL_SYS_STOP_CMD,BOOL,,,,coil,8020,
COIL_SYS_RESET_CMD,BOOL,,,,coil,8030,
COIL_SYS_HAND_CMD,BOOL,,,,coil,8040,
COIL_SYS_AUTO_CMD,BOOL,,,,coil,8050,
COIL_SYS_INIT_CMD,BOOL,,,,coil,8060,
COIL_UNILAB_SEND_MSG_SUCC_CMD,BOOL,,,,coil,8700,
COIL_UNILAB_REC_MSG_SUCC_CMD,BOOL,,,,coil,8710,unilab_rec_msg_succ_cmd
COIL_SYS_START_STATUS,BOOL,,,,coil,8210,
COIL_SYS_STOP_STATUS,BOOL,,,,coil,8220,
COIL_SYS_RESET_STATUS,BOOL,,,,coil,8230,
COIL_SYS_HAND_STATUS,BOOL,,,,coil,8240,
COIL_SYS_AUTO_STATUS,BOOL,,,,coil,8250,
COIL_SYS_INIT_STATUS,BOOL,,,,coil,8260,
COIL_REQUEST_REC_MSG_STATUS,BOOL,,,,coil,8500,
COIL_REQUEST_SEND_MSG_STATUS,BOOL,,,,coil,8510,request_send_msg_status
REG_MSG_ELECTROLYTE_USE_NUM,INT16,,,,hold_register,11000,
REG_MSG_ELECTROLYTE_NUM,INT16,,,,hold_register,11002,unilab_send_msg_electrolyte_num
REG_MSG_ELECTROLYTE_VOLUME,INT16,,,,hold_register,11004,unilab_send_msg_electrolyte_vol
REG_MSG_ASSEMBLY_TYPE,INT16,,,,hold_register,11006,unilab_send_msg_assembly_type
REG_MSG_ASSEMBLY_PRESSURE,INT16,,,,hold_register,11008,unilab_send_msg_assembly_pressure
REG_DATA_ASSEMBLY_COIN_CELL_NUM,INT16,,,,hold_register,10000,data_assembly_coin_cell_num
REG_DATA_OPEN_CIRCUIT_VOLTAGE,FLOAT32,,,,hold_register,10002,data_open_circuit_voltage
REG_DATA_AXIS_X_POS,FLOAT32,,,,hold_register,10004,
REG_DATA_AXIS_Y_POS,FLOAT32,,,,hold_register,10006,
REG_DATA_AXIS_Z_POS,FLOAT32,,,,hold_register,10008,
REG_DATA_POLE_WEIGHT,FLOAT32,,,,hold_register,10010,data_pole_weight
REG_DATA_ASSEMBLY_PER_TIME,FLOAT32,,,,hold_register,10012,data_assembly_time
REG_DATA_ASSEMBLY_PRESSURE,INT16,,,,hold_register,10014,data_assembly_pressure
REG_DATA_ELECTROLYTE_VOLUME,INT16,,,,hold_register,10016,data_electrolyte_volume
REG_DATA_COIN_NUM,INT16,,,,hold_register,10018,data_coin_num
REG_DATA_ELECTROLYTE_CODE,STRING,,,,hold_register,10020,data_electrolyte_code()
REG_DATA_COIN_CELL_CODE,STRING,,,,hold_register,10030,data_coin_cell_code()
REG_DATA_STACK_VISON_CODE,STRING,,,,hold_register,12004,data_stack_vision_code()
REG_DATA_GLOVE_BOX_PRESSURE,FLOAT32,,,,hold_register,10050,data_glove_box_pressure
REG_DATA_GLOVE_BOX_WATER_CONTENT,FLOAT32,,,,hold_register,10052,data_glove_box_water_content
REG_DATA_GLOVE_BOX_O2_CONTENT,FLOAT32,,,,hold_register,10054,data_glove_box_o2_content
UNILAB_SEND_ELECTROLYTE_BOTTLE_NUM,BOOL,,,,coil,8720,
UNILAB_RECE_ELECTROLYTE_BOTTLE_NUM,BOOL,,,,coil,8520,
REG_MSG_ELECTROLYTE_NUM_USED,INT16,,,,hold_register,496,
REG_DATA_ELECTROLYTE_USE_NUM,INT16,,,,hold_register,10000,
UNILAB_SEND_FINISHED_CMD,BOOL,,,,coil,8730,
UNILAB_RECE_FINISHED_CMD,BOOL,,,,coil,8530,
REG_DATA_ASSEMBLY_TYPE,INT16,,,,hold_register,10018,ASSEMBLY_TYPE7or8
REG_UNILAB_INTERACT,BOOL,,,,coil,8450,
,,,,,coil,8320,
COIL_ALUMINUM_FOIL,BOOL,,,,coil,8340,
REG_MSG_NE_PLATE_MATRIX,INT16,,,,hold_register,440,
REG_MSG_SEPARATOR_PLATE_MATRIX,INT16,,,,hold_register,450,
REG_MSG_TIP_BOX_MATRIX,INT16,,,,hold_register,480,
REG_MSG_NE_PLATE_NUM,INT16,,,,hold_register,443,
REG_MSG_SEPARATOR_PLATE_NUM,INT16,,,,hold_register,453,
REG_MSG_PRESS_MODE,BOOL,,,,coil,8360,
,BOOL,,,,coil,8300,
,BOOL,,,,coil,8310,
COIL_GB_L_IGNORE_CMD,BOOL,,,,coil,8320,
COIL_GB_R_IGNORE_CMD,BOOL,,,,coil,8420,
,BOOL,,,,coil,8350,
COIL_ELECTROLYTE_DUAL_DROP_MODE,BOOL,,,,coil,8370,
,BOOL,,,,coil,8380,
,BOOL,,,,coil,8390,
,BOOL,,,,coil,8400,
,BOOL,,,,coil,8410,
REG_MSG_DUAL_DROP_FIRST_VOLUME,INT16,,,,hold_register,4001,
COIL_DUAL_DROP_SUCTION_TIMING,BOOL,,,,coil,8430,
COIL_DUAL_DROP_START_TIMING,BOOL,,,,coil,8470,
REG_MSG_BATTERY_CLEAN_IGNORE,BOOL,,,,coil,8460,
COIL_MATERIAL_SEARCH_DIALOG_APPEAR,BOOL,,,,coil,6470,
COIL_MATERIAL_SEARCH_CONFIRM_YES,BOOL,,,,coil,6480,
COIL_MATERIAL_SEARCH_CONFIRM_NO,BOOL,,,,coil,6490,
COIL_ALARM_100_SYSTEM_ERROR,BOOL,,,,coil,1000,异常100-系统异常
COIL_ALARM_101_EMERGENCY_STOP,BOOL,,,,coil,1010,异常101-急停
COIL_ALARM_111_GLOVEBOX_EMERGENCY_STOP,BOOL,,,,coil,1110,异常111-手套箱急停
COIL_ALARM_112_GLOVEBOX_GRATING_BLOCKED,BOOL,,,,coil,1120,异常112-手套箱内光栅遮挡
COIL_ALARM_160_PIPETTE_TIP_SHORTAGE,BOOL,,,,coil,1600,异常160-移液枪头缺料
COIL_ALARM_161_POSITIVE_SHELL_SHORTAGE,BOOL,,,,coil,1610,异常161-正极壳缺料
COIL_ALARM_162_ALUMINUM_FOIL_SHORTAGE,BOOL,,,,coil,1620,异常162-铝箔垫缺料
COIL_ALARM_163_POSITIVE_PLATE_SHORTAGE,BOOL,,,,coil,1630,异常163-正极片缺料
COIL_ALARM_164_SEPARATOR_SHORTAGE,BOOL,,,,coil,1640,异常164-隔膜缺料
COIL_ALARM_165_NEGATIVE_PLATE_SHORTAGE,BOOL,,,,coil,1650,异常165-负极片缺料
COIL_ALARM_166_FLAT_WASHER_SHORTAGE,BOOL,,,,coil,1660,异常166-平垫缺料
COIL_ALARM_167_SPRING_WASHER_SHORTAGE,BOOL,,,,coil,1670,异常167-弹垫缺料
COIL_ALARM_168_NEGATIVE_SHELL_SHORTAGE,BOOL,,,,coil,1680,异常168-负极壳缺料
COIL_ALARM_169_FINISHED_BATTERY_FULL,BOOL,,,,coil,1690,异常169-成品电池满料
COIL_ALARM_201_SERVO_AXIS_01_ERROR,BOOL,,,,coil,2010,异常201-伺服轴01异常
COIL_ALARM_202_SERVO_AXIS_02_ERROR,BOOL,,,,coil,2020,异常202-伺服轴02异常
COIL_ALARM_203_SERVO_AXIS_03_ERROR,BOOL,,,,coil,2030,异常203-伺服轴03异常
COIL_ALARM_204_SERVO_AXIS_04_ERROR,BOOL,,,,coil,2040,异常204-伺服轴04异常
COIL_ALARM_205_SERVO_AXIS_05_ERROR,BOOL,,,,coil,2050,异常205-伺服轴05异常
COIL_ALARM_206_SERVO_AXIS_06_ERROR,BOOL,,,,coil,2060,异常206-伺服轴06异常
COIL_ALARM_207_SERVO_AXIS_07_ERROR,BOOL,,,,coil,2070,异常207-伺服轴07异常
COIL_ALARM_208_SERVO_AXIS_08_ERROR,BOOL,,,,coil,2080,异常208-伺服轴08异常
COIL_ALARM_209_SERVO_AXIS_09_ERROR,BOOL,,,,coil,2090,异常209-伺服轴09异常
COIL_ALARM_210_SERVO_AXIS_10_ERROR,BOOL,,,,coil,2100,异常210-伺服轴10异常
COIL_ALARM_211_SERVO_AXIS_11_ERROR,BOOL,,,,coil,2110,异常211-伺服轴11异常
COIL_ALARM_212_SERVO_AXIS_12_ERROR,BOOL,,,,coil,2120,异常212-伺服轴12异常
COIL_ALARM_213_SERVO_AXIS_13_ERROR,BOOL,,,,coil,2130,异常213-伺服轴13异常
COIL_ALARM_214_SERVO_AXIS_14_ERROR,BOOL,,,,coil,2140,异常214-伺服轴14异常
COIL_ALARM_250_OTHER_COMPONENT_ERROR,BOOL,,,,coil,2500,异常250-其他元件异常
COIL_ALARM_251_PIPETTE_COMM_ERROR,BOOL,,,,coil,2510,异常251-移液枪通讯异常
COIL_ALARM_252_PIPETTE_ALARM,BOOL,,,,coil,2520,异常252-移液枪报警
COIL_ALARM_256_ELECTRIC_GRIPPER_ERROR,BOOL,,,,coil,2560,异常256-电爪异常
COIL_ALARM_262_RB_UNKNOWN_POSITION_ERROR,BOOL,,,,coil,2620,异常262-RB报警未知点位错误
COIL_ALARM_263_RB_XYZ_PARAM_LIMIT_ERROR,BOOL,,,,coil,2630,异常263-RB报警X、Y、Z参数超限制
COIL_ALARM_264_RB_VISION_PARAM_ERROR,BOOL,,,,coil,2640,异常264-RB报警视觉参数误差过大
COIL_ALARM_265_RB_NOZZLE_1_PICK_FAIL,BOOL,,,,coil,2650,异常265-RB报警1#吸嘴取料失败
COIL_ALARM_266_RB_NOZZLE_2_PICK_FAIL,BOOL,,,,coil,2660,异常266-RB报警2#吸嘴取料失败
COIL_ALARM_267_RB_NOZZLE_3_PICK_FAIL,BOOL,,,,coil,2670,异常267-RB报警3#吸嘴取料失败
COIL_ALARM_268_RB_NOZZLE_4_PICK_FAIL,BOOL,,,,coil,2680,异常268-RB报警4#吸嘴取料失败
COIL_ALARM_269_RB_TRAY_PICK_FAIL,BOOL,,,,coil,2690,异常269-RB报警取物料盘失败
COIL_ALARM_280_RB_COLLISION_ERROR,BOOL,,,,coil,2800,异常280-RB碰撞异常
COIL_ALARM_290_VISION_SYSTEM_COMM_ERROR,BOOL,,,,coil,2900,异常290-视觉系统通讯异常
COIL_ALARM_291_VISION_ALIGNMENT_NG,BOOL,,,,coil,2910,异常291-视觉对位NG异常
COIL_ALARM_292_BARCODE_SCANNER_COMM_ERROR,BOOL,,,,coil,2920,异常292-扫码枪通讯异常
COIL_ALARM_310_OCV_TRANSFER_NOZZLE_SUCTION_ERROR,BOOL,,,,coil,3100,异常310-开电移载吸嘴吸真空异常
COIL_ALARM_311_OCV_TRANSFER_NOZZLE_BREAK_ERROR,BOOL,,,,coil,3110,异常311-开电移载吸嘴破真空异常
COIL_ALARM_312_WEIGHT_TRANSFER_NOZZLE_SUCTION_ERROR,BOOL,,,,coil,3120,异常312-称重移载吸嘴吸真空异常
COIL_ALARM_313_WEIGHT_TRANSFER_NOZZLE_BREAK_ERROR,BOOL,,,,coil,3130,异常313-称重移载吸嘴破真空异常
COIL_ALARM_340_OCV_NOZZLE_TRANSFER_CYLINDER_ERROR,BOOL,,,,coil,3400,异常340-开路电压吸嘴移载气缸异常
COIL_ALARM_342_OCV_NOZZLE_LIFT_CYLINDER_ERROR,BOOL,,,,coil,3420,异常342-开路电压吸嘴升降气缸异常
COIL_ALARM_344_OCV_CRIMPING_CYLINDER_ERROR,BOOL,,,,coil,3440,异常344-开路电压旋压气缸异常
COIL_ALARM_350_WEIGHT_NOZZLE_TRANSFER_CYLINDER_ERROR,BOOL,,,,coil,3500,异常350-称重吸嘴移载气缸异常
COIL_ALARM_352_WEIGHT_NOZZLE_LIFT_CYLINDER_ERROR,BOOL,,,,coil,3520,异常352-称重吸嘴升降气缸异常
COIL_ALARM_354_CLEANING_CLOTH_TRANSFER_CYLINDER_ERROR,BOOL,,,,coil,3540,异常354-清洗无尘布移载气缸异常
COIL_ALARM_356_CLEANING_CLOTH_PRESS_CYLINDER_ERROR,BOOL,,,,coil,3560,异常356-清洗无尘布压紧气缸异常
COIL_ALARM_360_ELECTROLYTE_BOTTLE_POSITION_CYLINDER_ERROR,BOOL,,,,coil,3600,异常360-电解液瓶定位气缸异常
COIL_ALARM_362_PIPETTE_TIP_BOX_POSITION_CYLINDER_ERROR,BOOL,,,,coil,3620,异常362-移液枪头盒定位气缸异常
COIL_ALARM_364_REAGENT_BOTTLE_GRIPPER_LIFT_CYLINDER_ERROR,BOOL,,,,coil,3640,异常364-试剂瓶夹爪升降气缸异常
COIL_ALARM_366_REAGENT_BOTTLE_GRIPPER_CYLINDER_ERROR,BOOL,,,,coil,3660,异常366-试剂瓶夹爪气缸异常
COIL_ALARM_370_PRESS_MODULE_BLOW_CYLINDER_ERROR,BOOL,,,,coil,3700,异常370-压制模块吹气气缸异常
COIL_ALARM_151_ELECTROLYTE_BOTTLE_POSITION_ERROR,BOOL,,,,coil,1510,异常151-电解液瓶定位在籍异常
COIL_ALARM_152_ELECTROLYTE_BOTTLE_CAP_ERROR,BOOL,,,,coil,1520,异常152-电解液瓶盖在籍异常
1 Name DataType InitValue Comment Attribute DeviceType Address
2 COIL_SYS_START_CMD BOOL coil 8010
3 COIL_SYS_STOP_CMD BOOL coil 8020
4 COIL_SYS_RESET_CMD BOOL coil 8030
5 COIL_SYS_HAND_CMD BOOL coil 8040
6 COIL_SYS_AUTO_CMD BOOL coil 8050
7 COIL_SYS_INIT_CMD BOOL coil 8060
8 COIL_UNILAB_SEND_MSG_SUCC_CMD BOOL coil 8700
9 COIL_UNILAB_REC_MSG_SUCC_CMD BOOL coil 8710 unilab_rec_msg_succ_cmd
10 COIL_SYS_START_STATUS BOOL coil 8210
11 COIL_SYS_STOP_STATUS BOOL coil 8220
12 COIL_SYS_RESET_STATUS BOOL coil 8230
13 COIL_SYS_HAND_STATUS BOOL coil 8240
14 COIL_SYS_AUTO_STATUS BOOL coil 8250
15 COIL_SYS_INIT_STATUS BOOL coil 8260
16 COIL_REQUEST_REC_MSG_STATUS BOOL coil 8500
17 COIL_REQUEST_SEND_MSG_STATUS BOOL coil 8510 request_send_msg_status
18 REG_MSG_ELECTROLYTE_USE_NUM INT16 hold_register 11000
19 REG_MSG_ELECTROLYTE_NUM INT16 hold_register 11002 unilab_send_msg_electrolyte_num
20 REG_MSG_ELECTROLYTE_VOLUME INT16 hold_register 11004 unilab_send_msg_electrolyte_vol
21 REG_MSG_ASSEMBLY_TYPE INT16 hold_register 11006 unilab_send_msg_assembly_type
22 REG_MSG_ASSEMBLY_PRESSURE INT16 hold_register 11008 unilab_send_msg_assembly_pressure
23 REG_DATA_ASSEMBLY_COIN_CELL_NUM INT16 hold_register 10000 data_assembly_coin_cell_num
24 REG_DATA_OPEN_CIRCUIT_VOLTAGE FLOAT32 hold_register 10002 data_open_circuit_voltage
25 REG_DATA_AXIS_X_POS FLOAT32 hold_register 10004
26 REG_DATA_AXIS_Y_POS FLOAT32 hold_register 10006
27 REG_DATA_AXIS_Z_POS FLOAT32 hold_register 10008
28 REG_DATA_POLE_WEIGHT FLOAT32 hold_register 10010 data_pole_weight
29 REG_DATA_ASSEMBLY_PER_TIME FLOAT32 hold_register 10012 data_assembly_time
30 REG_DATA_ASSEMBLY_PRESSURE INT16 hold_register 10014 data_assembly_pressure
31 REG_DATA_ELECTROLYTE_VOLUME INT16 hold_register 10016 data_electrolyte_volume
32 REG_DATA_COIN_NUM INT16 hold_register 10018 data_coin_num
33 REG_DATA_ELECTROLYTE_CODE STRING hold_register 10020 data_electrolyte_code()
34 REG_DATA_COIN_CELL_CODE STRING hold_register 10030 data_coin_cell_code()
35 REG_DATA_STACK_VISON_CODE STRING hold_register 12004 data_stack_vision_code()
36 REG_DATA_GLOVE_BOX_PRESSURE FLOAT32 hold_register 10050 data_glove_box_pressure
37 REG_DATA_GLOVE_BOX_WATER_CONTENT FLOAT32 hold_register 10052 data_glove_box_water_content
38 REG_DATA_GLOVE_BOX_O2_CONTENT FLOAT32 hold_register 10054 data_glove_box_o2_content
39 UNILAB_SEND_ELECTROLYTE_BOTTLE_NUM BOOL coil 8720
40 UNILAB_RECE_ELECTROLYTE_BOTTLE_NUM BOOL coil 8520
41 REG_MSG_ELECTROLYTE_NUM_USED INT16 hold_register 496
42 REG_DATA_ELECTROLYTE_USE_NUM INT16 hold_register 10000
43 UNILAB_SEND_FINISHED_CMD BOOL coil 8730
44 UNILAB_RECE_FINISHED_CMD BOOL coil 8530
45 REG_DATA_ASSEMBLY_TYPE INT16 hold_register 10018 ASSEMBLY_TYPE7or8
46 REG_UNILAB_INTERACT BOOL coil 8450
47 coil 8320
48 COIL_ALUMINUM_FOIL BOOL coil 8340
49 REG_MSG_NE_PLATE_MATRIX INT16 hold_register 440
50 REG_MSG_SEPARATOR_PLATE_MATRIX INT16 hold_register 450
51 REG_MSG_TIP_BOX_MATRIX INT16 hold_register 480
52 REG_MSG_NE_PLATE_NUM INT16 hold_register 443
53 REG_MSG_SEPARATOR_PLATE_NUM INT16 hold_register 453
54 REG_MSG_PRESS_MODE BOOL coil 8360
55 BOOL coil 8300
56 BOOL coil 8310
57 COIL_GB_L_IGNORE_CMD BOOL coil 8320
58 COIL_GB_R_IGNORE_CMD BOOL coil 8420
59 BOOL coil 8350
60 COIL_ELECTROLYTE_DUAL_DROP_MODE BOOL coil 8370
61 BOOL coil 8380
62 BOOL coil 8390
63 BOOL coil 8400
64 BOOL coil 8410
65 REG_MSG_DUAL_DROP_FIRST_VOLUME INT16 hold_register 4001
66 COIL_DUAL_DROP_SUCTION_TIMING BOOL coil 8430
67 COIL_DUAL_DROP_START_TIMING BOOL coil 8470
68 REG_MSG_BATTERY_CLEAN_IGNORE BOOL coil 8460
69 COIL_MATERIAL_SEARCH_DIALOG_APPEAR BOOL coil 6470
70 COIL_MATERIAL_SEARCH_CONFIRM_YES BOOL coil 6480
71 COIL_MATERIAL_SEARCH_CONFIRM_NO BOOL coil 6490
72 COIL_ALARM_100_SYSTEM_ERROR BOOL coil 1000 异常100-系统异常
73 COIL_ALARM_101_EMERGENCY_STOP BOOL coil 1010 异常101-急停
74 COIL_ALARM_111_GLOVEBOX_EMERGENCY_STOP BOOL coil 1110 异常111-手套箱急停
75 COIL_ALARM_112_GLOVEBOX_GRATING_BLOCKED BOOL coil 1120 异常112-手套箱内光栅遮挡
76 COIL_ALARM_160_PIPETTE_TIP_SHORTAGE BOOL coil 1600 异常160-移液枪头缺料
77 COIL_ALARM_161_POSITIVE_SHELL_SHORTAGE BOOL coil 1610 异常161-正极壳缺料
78 COIL_ALARM_162_ALUMINUM_FOIL_SHORTAGE BOOL coil 1620 异常162-铝箔垫缺料
79 COIL_ALARM_163_POSITIVE_PLATE_SHORTAGE BOOL coil 1630 异常163-正极片缺料
80 COIL_ALARM_164_SEPARATOR_SHORTAGE BOOL coil 1640 异常164-隔膜缺料
81 COIL_ALARM_165_NEGATIVE_PLATE_SHORTAGE BOOL coil 1650 异常165-负极片缺料
82 COIL_ALARM_166_FLAT_WASHER_SHORTAGE BOOL coil 1660 异常166-平垫缺料
83 COIL_ALARM_167_SPRING_WASHER_SHORTAGE BOOL coil 1670 异常167-弹垫缺料
84 COIL_ALARM_168_NEGATIVE_SHELL_SHORTAGE BOOL coil 1680 异常168-负极壳缺料
85 COIL_ALARM_169_FINISHED_BATTERY_FULL BOOL coil 1690 异常169-成品电池满料
86 COIL_ALARM_201_SERVO_AXIS_01_ERROR BOOL coil 2010 异常201-伺服轴01异常
87 COIL_ALARM_202_SERVO_AXIS_02_ERROR BOOL coil 2020 异常202-伺服轴02异常
88 COIL_ALARM_203_SERVO_AXIS_03_ERROR BOOL coil 2030 异常203-伺服轴03异常
89 COIL_ALARM_204_SERVO_AXIS_04_ERROR BOOL coil 2040 异常204-伺服轴04异常
90 COIL_ALARM_205_SERVO_AXIS_05_ERROR BOOL coil 2050 异常205-伺服轴05异常
91 COIL_ALARM_206_SERVO_AXIS_06_ERROR BOOL coil 2060 异常206-伺服轴06异常
92 COIL_ALARM_207_SERVO_AXIS_07_ERROR BOOL coil 2070 异常207-伺服轴07异常
93 COIL_ALARM_208_SERVO_AXIS_08_ERROR BOOL coil 2080 异常208-伺服轴08异常
94 COIL_ALARM_209_SERVO_AXIS_09_ERROR BOOL coil 2090 异常209-伺服轴09异常
95 COIL_ALARM_210_SERVO_AXIS_10_ERROR BOOL coil 2100 异常210-伺服轴10异常
96 COIL_ALARM_211_SERVO_AXIS_11_ERROR BOOL coil 2110 异常211-伺服轴11异常
97 COIL_ALARM_212_SERVO_AXIS_12_ERROR BOOL coil 2120 异常212-伺服轴12异常
98 COIL_ALARM_213_SERVO_AXIS_13_ERROR BOOL coil 2130 异常213-伺服轴13异常
99 COIL_ALARM_214_SERVO_AXIS_14_ERROR BOOL coil 2140 异常214-伺服轴14异常
100 COIL_ALARM_250_OTHER_COMPONENT_ERROR BOOL coil 2500 异常250-其他元件异常
101 COIL_ALARM_251_PIPETTE_COMM_ERROR BOOL coil 2510 异常251-移液枪通讯异常
102 COIL_ALARM_252_PIPETTE_ALARM BOOL coil 2520 异常252-移液枪报警
103 COIL_ALARM_256_ELECTRIC_GRIPPER_ERROR BOOL coil 2560 异常256-电爪异常
104 COIL_ALARM_262_RB_UNKNOWN_POSITION_ERROR BOOL coil 2620 异常262-RB报警:未知点位错误
105 COIL_ALARM_263_RB_XYZ_PARAM_LIMIT_ERROR BOOL coil 2630 异常263-RB报警:X、Y、Z参数超限制
106 COIL_ALARM_264_RB_VISION_PARAM_ERROR BOOL coil 2640 异常264-RB报警:视觉参数误差过大
107 COIL_ALARM_265_RB_NOZZLE_1_PICK_FAIL BOOL coil 2650 异常265-RB报警:1#吸嘴取料失败
108 COIL_ALARM_266_RB_NOZZLE_2_PICK_FAIL BOOL coil 2660 异常266-RB报警:2#吸嘴取料失败
109 COIL_ALARM_267_RB_NOZZLE_3_PICK_FAIL BOOL coil 2670 异常267-RB报警:3#吸嘴取料失败
110 COIL_ALARM_268_RB_NOZZLE_4_PICK_FAIL BOOL coil 2680 异常268-RB报警:4#吸嘴取料失败
111 COIL_ALARM_269_RB_TRAY_PICK_FAIL BOOL coil 2690 异常269-RB报警:取物料盘失败
112 COIL_ALARM_280_RB_COLLISION_ERROR BOOL coil 2800 异常280-RB碰撞异常
113 COIL_ALARM_290_VISION_SYSTEM_COMM_ERROR BOOL coil 2900 异常290-视觉系统通讯异常
114 COIL_ALARM_291_VISION_ALIGNMENT_NG BOOL coil 2910 异常291-视觉对位NG异常
115 COIL_ALARM_292_BARCODE_SCANNER_COMM_ERROR BOOL coil 2920 异常292-扫码枪通讯异常
116 COIL_ALARM_310_OCV_TRANSFER_NOZZLE_SUCTION_ERROR BOOL coil 3100 异常310-开电移载吸嘴吸真空异常
117 COIL_ALARM_311_OCV_TRANSFER_NOZZLE_BREAK_ERROR BOOL coil 3110 异常311-开电移载吸嘴破真空异常
118 COIL_ALARM_312_WEIGHT_TRANSFER_NOZZLE_SUCTION_ERROR BOOL coil 3120 异常312-称重移载吸嘴吸真空异常
119 COIL_ALARM_313_WEIGHT_TRANSFER_NOZZLE_BREAK_ERROR BOOL coil 3130 异常313-称重移载吸嘴破真空异常
120 COIL_ALARM_340_OCV_NOZZLE_TRANSFER_CYLINDER_ERROR BOOL coil 3400 异常340-开路电压吸嘴移载气缸异常
121 COIL_ALARM_342_OCV_NOZZLE_LIFT_CYLINDER_ERROR BOOL coil 3420 异常342-开路电压吸嘴升降气缸异常
122 COIL_ALARM_344_OCV_CRIMPING_CYLINDER_ERROR BOOL coil 3440 异常344-开路电压旋压气缸异常
123 COIL_ALARM_350_WEIGHT_NOZZLE_TRANSFER_CYLINDER_ERROR BOOL coil 3500 异常350-称重吸嘴移载气缸异常
124 COIL_ALARM_352_WEIGHT_NOZZLE_LIFT_CYLINDER_ERROR BOOL coil 3520 异常352-称重吸嘴升降气缸异常
125 COIL_ALARM_354_CLEANING_CLOTH_TRANSFER_CYLINDER_ERROR BOOL coil 3540 异常354-清洗无尘布移载气缸异常
126 COIL_ALARM_356_CLEANING_CLOTH_PRESS_CYLINDER_ERROR BOOL coil 3560 异常356-清洗无尘布压紧气缸异常
127 COIL_ALARM_360_ELECTROLYTE_BOTTLE_POSITION_CYLINDER_ERROR BOOL coil 3600 异常360-电解液瓶定位气缸异常
128 COIL_ALARM_362_PIPETTE_TIP_BOX_POSITION_CYLINDER_ERROR BOOL coil 3620 异常362-移液枪头盒定位气缸异常
129 COIL_ALARM_364_REAGENT_BOTTLE_GRIPPER_LIFT_CYLINDER_ERROR BOOL coil 3640 异常364-试剂瓶夹爪升降气缸异常
130 COIL_ALARM_366_REAGENT_BOTTLE_GRIPPER_CYLINDER_ERROR BOOL coil 3660 异常366-试剂瓶夹爪气缸异常
131 COIL_ALARM_370_PRESS_MODULE_BLOW_CYLINDER_ERROR BOOL coil 3700 异常370-压制模块吹气气缸异常
132 COIL_ALARM_151_ELECTROLYTE_BOTTLE_POSITION_ERROR BOOL coil 1510 异常151-电解液瓶定位在籍异常
133 COIL_ALARM_152_ELECTROLYTE_BOTTLE_CAP_ERROR BOOL coil 1520 异常152-电解液瓶盖在籍异常

View File

@@ -459,12 +459,12 @@ class WorkstationHTTPHandler(BaseHTTPRequestHandler):
# 验证必需字段
if 'brand' in request_data:
if request_data['brand'] == "bioyond": # 奔曜
error_msg = request_data["text"]
logger.info(f"收到奔曜错误处理报送: {error_msg}")
material_data = request_data["text"]
logger.info(f"收到奔曜物料变更报送: {material_data}")
return HttpResponse(
success=True,
message=f"错误处理报送已收到: {error_msg}",
acknowledgment_id=f"ERROR_{int(time.time() * 1000)}_{error_msg.get('action_id', 'unknown')}",
message=f"物料变更报送已收到: {material_data}",
acknowledgment_id=f"MATERIAL_{int(time.time() * 1000)}_{material_data.get('id', 'unknown')}",
data=None
)
else:

View File

@@ -0,0 +1,634 @@
# Layout Optimizer Handover
**Date**: 2026-04-10 | **Branch**: `feat/3d_layout_and_visualize` | **Commit**: `99dc821a` | **Tests**: 270 (260 pass + 10 LLM skip w/o API key)
This package is a standalone lab layout optimizer. It takes a device list + constraints and returns optimized placements. Your integration points are the HTTP API and the LLM skill document.
---
## 1. Full Pipeline Overview
```
User NL request
┌─────────────────┐ skill doc: llm_skill/layout_intent_translator.md
│ LLM Agent │◄── + device list from scene (GET /devices)
│ (your side) │ + schema discovery (GET /interpret/schema)
└────────┬────────┘
│ structured intents JSON
POST /interpret ← intent_interpreter.py (pure translation)
│ { constraints, translations, workflow_edges, errors }
User confirms ← translations have human-readable explanations
POST /optimize ← full pipeline below
┌────┴─────────────────────────────────────────┐
│ 1. Device catalog (device_catalog.py) │
│ footprints.json → Device objects │
│ bbox, height, openings per device │
│ │
│ 2. Seeder (seeders.py) │
│ Force-directed initial placement │
│ Presets: compact_outward, spread_inward, │
│ workflow_cluster, row_fallback │
│ Accounts for openings, workflow edges │
│ │
│ 3. DE Optimizer (optimizer.py) │
│ Custom DE loop (best1bin/currenttobest1bin│
│ /rand1bin strategies) │
│ 3N-dim: [x0, y0, θ0, x1, y1, θ1, ...] │
│ Broad-phase AABB sweep (broad_phase.py) │
│ θ lattice snap in joint discrete mode │
│ Cost = hard_penalties + soft_penalties │
│ Graduated collision penalties (not binary) │
│ │
│ 4. θ snap (optimizer.snap_theta) │
│ Snap near-cardinal angles to 0/90/180/270 │
│ (opt-in via snap_cardinal=True) │
│ │
│ 5. Final eval (constraints.py) │
│ Binary pass/fail for response.success │
└──────────────────────────────────────────────┘
{ placements, cost, success }
```
---
## 2. API Reference
### `POST /interpret` — LLM intent → constraints
Translates semantic intents into optimizer constraints. The LLM agent calls this after translating user NL.
**Request:**
```json
{
"intents": [
{
"intent": "reachable_by",
"params": {"arm": "arm_slider", "targets": ["opentrons_liquid_handler", "inheco_odtc_96xl"]},
"description": "Robot arm must reach these devices"
},
{
"intent": "workflow_hint",
"params": {"workflow": "pcr", "devices": ["device_a", "device_b", "device_c"]},
"description": "PCR workflow order"
},
{
"intent": "close_together",
"params": {"devices": ["device_a", "device_b"], "priority": "high"},
"description": "Keep these close"
}
]
}
```
**Response:**
```json
{
"constraints": [
{"type": "hard", "rule_name": "reachability", "params": {"arm_id": "arm_slider", "target_device_id": "opentrons_liquid_handler"}, "weight": 1.0},
...
],
"translations": [
{
"source_intent": "reachable_by",
"source_description": "Robot arm must reach these devices",
"source_params": {"arm": "arm_slider", "targets": ["..."]},
"generated_constraints": [...],
"explanation": "机械臂 'arm_slider' 需要能够到达 2 个目标设备",
"confidence": "high"
}
],
"workflow_edges": [["device_a", "device_b"], ["device_b", "device_c"]],
"errors": []
}
```
The `constraints` and `workflow_edges` arrays pass directly to `/optimize` — no transformation needed.
### `GET /interpret/schema` — LLM discovery
Returns all 11 intent types with parameter specs. LLM agent should call this before translating.
### `POST /optimize` — Run layout optimization
**Request:**
```json
{
"devices": [
{"id": "thermo_orbitor_rs2_hotel", "name": "Plate Hotel", "device_type": "static"},
{"id": "arm_slider", "name": "Robot Arm", "device_type": "articulation"},
...
],
"lab": {"width": 6.0, "depth": 4.0},
"constraints": [...],
"workflow_edges": [["device_a", "device_b"]],
"seeder": "compact_outward",
"run_de": true,
"maxiter": 200,
"seed": 42,
"angle_granularity": 4,
"snap_cardinal": false,
"strategy": "currenttobest1bin",
"mutation": [0.5, 1.0],
"theta_mutation": null,
"recombination": 0.7,
"crossover_mode": "device"
}
```
**Response:**
```json
{
"placements": [
{
"device_id": "thermo_orbitor_rs2_hotel",
"uuid": "thermo_orbitor_rs2_hotel",
"position": {"x": 1.33, "y": 2.35, "z": 0.0},
"rotation": {"x": 0.0, "y": 0.0, "z": 1.5708}
},
...
],
"cost": 0.0,
"success": true,
"seeder_used": "compact_outward",
"de_ran": true
}
```
`position`/`rotation` format matches Cloud's `CommonPositionType`. `rotation.z` is θ in radians.
**DE hyperparameters:**
| Param | Default | Description |
|-------|---------|-------------|
| `strategy` | `"currenttobest1bin"` | DE mutation strategy (`best1bin`, `currenttobest1bin`, `rand1bin`) |
| `mutation` | `[0.5, 1.0]` | Dithered F range for position dimensions |
| `theta_mutation` | `null` (same as `mutation`) | Separate F range for θ dimensions (decoupled mutation) |
| `recombination` | `0.7` | Crossover probability |
| `crossover_mode` | `"device"` | `"device"` = per-device CR, `"dimension"` = per-dimension CR |
| `angle_granularity` | `null` | `4`/`8`/`12`/`24` — snaps θ to a discrete lattice during DE (joint mode). `4` = axis-aligned (0/90/180/270). `null` = continuous θ |
| `snap_cardinal` | `false` | Post-DE snap to nearest cardinal angle with collision rollback |
### Scene State API
Shared scene state between the LLM agent and the frontend. The agent pushes layout results here; the frontend polls for updates.
#### `GET /scene/lab` / `POST /scene/lab` — Lab dimensions
**GET** returns current lab dimensions. **POST** sets them (frontend sends this when user changes lab size).
```json
{"width": 6.0, "depth": 4.0}
```
#### `GET /scene/placements` / `POST /scene/placements` / `DELETE /scene/placements`
**GET** returns current placements + a version counter. Frontend polls this every 1s and re-renders when version changes.
```json
{"version": 3, "placements": [...]}
```
**POST** pushes new placements (from `/optimize` result or agent). Bumps version.
**DELETE** clears all placements (resets scene).
### `GET /devices` — Device catalog
Returns all known devices with bbox, openings, model paths. The LLM agent should receive this list as context so it can resolve fuzzy device names.
### `GET /health`
Returns `{"status": "ok"}`.
---
## 3. Intent Types (11 total)
| Intent | Params | Generates | Type |
|--------|--------|-----------|------|
| `reachable_by` | `arm` (str), `targets` (list[str]) | `reachability` per target | hard |
| `close_together` | `devices` (list[str]), `priority` (low/medium/high) | `minimize_distance` per pair | soft |
| `far_apart` | `devices` (list[str]), `priority` | `maximize_distance` per pair | soft |
| `keep_adjacent` | `devices` (list[str]), `priority` | `minimize_distance` per pair | soft |
| `max_distance` | `device_a`, `device_b`, `distance` (float m) | `distance_less_than` | hard |
| `min_distance` | `device_a`, `device_b`, `distance` (float m) | `distance_greater_than` | hard |
| `min_spacing` | `min_gap` (float m, default 0.3) | `min_spacing` | hard |
| `workflow_hint` | `workflow` (str), `devices` (ordered list[str]) | `minimize_distance` consecutive + `workflow_edges` | soft |
| `face_outward` | (none) | `prefer_orientation_mode` outward | soft |
| `face_inward` | (none) | `prefer_orientation_mode` inward | soft |
| `align_cardinal` | (none) | `prefer_aligned` | soft |
Intent priorities are baked into the final emitted constraint `weight` during interpretation. The caller only sees the resulting weight, not a separate constraint-level priority field.
---
## 4. LLM Integration Guide
### What You Need to Build (Your Side)
The LLM agent that converts user natural language → structured intents JSON. We provide:
1. **Skill document** (`llm_skill/layout_intent_translator.md`) — system prompt for the LLM. Contains intent schema, device name resolution rules, translation rules, and PCR workflow examples.
2. **Runtime schema** (`GET /interpret/schema`) — machine-readable intent specs. LLM agent should call this for discovery.
3. **Device context** — before translating, feed the LLM the scene's device list (from `GET /devices` or your scene state). The LLM uses this to resolve fuzzy names like "PCR machine" → `inheco_odtc_96xl`.
### Integration Flow
```
1. User enters NL request in Cloud UI
2. Your LLM agent receives:
- User message
- Scene device list (id, name, type, bbox)
- Skill doc as system prompt
- Optional: GET /interpret/schema for discovery
3. LLM outputs: {"intents": [...]}
4. POST /interpret with LLM output
5. Show user the translations for confirmation
6. POST /optimize with confirmed constraints + workflow_edges
7. Apply placements to scene
```
### Device Name Resolution (handled by LLM, not by optimizer)
The skill doc teaches the LLM to match fuzzy names:
- "PCR machine" / "thermal cycler" → `inheco_odtc_96xl`
- "liquid handler" / "pipetting robot" → `opentrons_liquid_handler`
- "plate hotel" / "storage" → `thermo_orbitor_rs2_hotel`
- "robot arm" / "the arm" → device with `type: articulation`
- "plate sealer" → `agilent_plateloc`
No search endpoint needed — the device list is already in context.
### Tested LLM Outputs
We tested with Claude Sonnet (via subagent, no API key required). Examples:
**Input**: "Take plate from hotel, prepare sample in the pipetting robot, seal it, then run thermal cycling. The arm handles all transfers. Keep liquid handler and sealer close, minimum 15cm gap."
**LLM produced**: `reachable_by` (arm→4 devices), `workflow_hint` (correct PCR order), `close_together` (high, LH+sealer), `min_distance` (0.15m, LH+sealer)
**Input**: "I want an automatic PCR lab, make it compact and neat"
**LLM produced**: `reachable_by`, `workflow_hint`, `close_together` (all devices), `min_spacing` (0.05m), `align_cardinal`
All outputs pass through `/interpret``/optimize` successfully.
---
## 5. Constraint System Details
### Hard Constraints (cost = ∞ on violation)
| Rule Name | Params | What it checks |
|-----------|--------|---------------|
| `no_collision` | (default, always on) | OBB-SAT pairwise collision between all devices |
| `within_bounds` | (default, always on) | All devices within lab boundary |
| `reachability` | `arm_id`, `target_device_id` | Target center within arm reach radius |
| `distance_less_than` | `device_a`, `device_b`, `distance` | OBB edge-to-edge distance ≤ threshold |
| `distance_greater_than` | `device_a`, `device_b`, `distance` | OBB edge-to-edge distance ≥ threshold |
| `min_spacing` | `min_gap` | All device pairs have ≥ min_gap edge-to-edge |
### Soft Constraints (weighted penalty)
| Rule Name | Params | What it minimizes |
|-----------|--------|------------------|
| `minimize_distance` | `device_a`, `device_b` | OBB edge-to-edge distance × weight |
| `maximize_distance` | `device_a`, `device_b` | 1/(distance+ε) × weight |
| `prefer_orientation_mode` | `mode` (outward/inward) | Angle between opening direction and ideal direction |
| `prefer_aligned` | (none) | Deviation from nearest 90° angle |
| `prefer_seeder_orientation` | (none) | Deviation from seeder-assigned θ |
| `crossing_penalty` | (auto, part of `reachability` eval) | Segment-OBB intersection length of opening-to-arm path blocked by other devices (Cyrus-Beck clipping via `obb.segment_obb_intersection_length`) |
### Weight Normalization
| Constant | Value | Meaning |
|----------|-------|---------|
| `DEFAULT_WEIGHT_DISTANCE` | 100.0 | 1 cm → penalty 1.0 |
| `DEFAULT_WEIGHT_ANGLE` | 60.0 | 5° → penalty ~1.0 |
| `HARD_MULTIPLIER` | 5.0 | Hard constraint penalty multiplier during graduated DE |
Constraints support a `priority` field (`critical` / `high` / `normal` / `low`) with multipliers 5× / 2× / 1× / 0.5×.
### Graduated Penalties (DE internals)
Default hard constraints (collision, boundary) use **graduated penalties** during DE optimization — proportional to penetration depth / overshoot distance. This gives DE a smooth gradient instead of binary inf. Final evaluation uses binary mode for pass/fail reporting.
---
## 6. Checker Architecture (Mock → Real)
```
interfaces.py (Protocol definitions)
├── CollisionChecker.check(placements) → collisions
├── CollisionChecker.check_bounds(placements, w, d) → out_of_bounds
└── ReachabilityChecker.is_reachable(arm_id, arm_pose, target) → bool
mock_checkers.py (current, no ROS)
├── MockCollisionChecker — OBB SAT
└── MockReachabilityChecker — Euclidean distance, 100m fallback for unknown arms
ros_checkers.py (for ROS2/MoveIt2 integration)
├── MoveItCollisionChecker — python-fcl direct + OBB fallback
└── IKFastReachabilityChecker — precomputed voxel O(1) + live IK fallback
└── create_checkers(mode) — factory, controlled by LAYOUT_CHECKER_MODE env var
```
To switch to real checkers: `LAYOUT_CHECKER_MODE=moveit` + pass MoveIt2 instance.
---
## 7. File Inventory
### Core Pipeline
| File | Lines | Purpose |
|------|-------|---------|
| `models.py` | 97 | Dataclasses: Device, Lab, Placement, Constraint, Intent, Opening |
| `device_catalog.py` | 303 | Loads devices from footprints.json + uni-lab-assets + registry |
| `footprints.json` | 183KB | 499 device bounding boxes, heights, openings (offline extracted) |
| `seeders.py` | 331 | Force-directed initial layout with presets |
| `optimizer.py` | 1056 | Custom DE loop: per-device crossover, θ wrapping, discrete angle lattice, multi-strategy |
| `broad_phase.py` | 66 | 2-axis sweep-and-prune AABB broad phase for collision pair pruning |
| `constraints.py` | 627 | Unified constraint evaluation (hard + soft + graduated + crossing penalty) |
| `obb.py` | 257 | OBB geometry: corners, overlap SAT, min_distance, penetration_depth, segment intersection |
| `intent_interpreter.py` | 366 | 11 intent handlers, pure translation, no side effects |
| `server.py` | 743 | FastAPI: /interpret, /optimize, /devices, /scene/* endpoints |
| `lab_parser.py` | 50 | Parse lab floor plan JSON to Lab dataclass |
### Reference / Utilities
| File | Purpose |
|------|---------|
| `extract_footprints.py` | How footprints.json was generated (offline STL/GLB → 2D bbox extraction via trimesh) |
| `generate_asset_registry.py` | Generate YAML registry entries for uni-lab-assets devices not already registered |
### Integration Layer
| File | Purpose |
|------|---------|
| `interfaces.py` | Protocol definitions for CollisionChecker / ReachabilityChecker |
| `mock_checkers.py` | Dev-mode checkers (OBB collision, Euclidean reachability) |
| `ros_checkers.py` | MoveIt2/IKFast adapters for real collision + reachability |
### LLM
| File | Purpose |
|------|---------|
| `llm_skill/layout_intent_translator.md` | System prompt for LLM: intent schema, device resolution, translation rules, examples |
| `llm_skill/demo_agent.md` | LLM agent orchestration instructions for demo (GET /devices → intents → /interpret → /optimize → /scene/placements) |
### Demo / Frontend
| File | Purpose |
|------|---------|
| `static/lab3d.html` | Three.js 3D visualization frontend (1227 lines): device library, drag-to-add, auto layout, scene polling |
### Configuration
| File | Purpose |
|------|---------|
| `pyproject.toml` | Package deps: scipy, numpy, fastapi, uvicorn, pydantic |
### Tests (270 total: 260 pass + 10 skip without API key)
| File | Tests | Coverage |
|------|-------|----------|
| `test_intent_interpreter.py` | 19 | All 11 handlers, validation, priority, multi-intent |
| `test_interpret_api.py` | 6 | /interpret and /interpret/schema endpoints |
| `test_e2e_pcr_pipeline.py` | 12 | Full pipeline: interpret → optimize → verify placements |
| `test_llm_skill.py` | 10 | Real LLM fuzzy input → structured output (needs ANTHROPIC_API_KEY) |
| `test_constraints.py` | 30 | Constraint evaluation, hard/soft, graduated penalties, crossing penalty |
| `test_optimizer.py` | 50 | DE optimizer, vector encoding, bounds, discrete angles, strategies |
| `test_mock_checkers.py` | 15 | MockCollisionChecker, MockReachabilityChecker |
| `test_ros_checkers.py` | 40 | MoveIt2/IKFast adapter tests |
| `test_seeders.py` | 12 | Force-directed seeder presets |
| `test_device_catalog.py` | 25 | Device loading, footprint merging |
| `test_obb.py` | 18 | OBB geometry functions, segment intersection |
| `test_bugfixes_v2.py` | 28 | Regression: duplicate IDs, orientation, min_spacing, cardinal snap defaults |
| `test_broad_phase.py` | 5 | Sweep-and-prune AABB broad phase |
---
## 8. How to Run
### Quick Start
```bash
# Install
pip install -e ".[dev]"
# Run server
uvicorn unilabos.layout_optimizer.server:app --host 0.0.0.0 --port 8000 --reload
# Run server with debug logging (shows DE cost breakdown per generation)
LAYOUT_DEBUG=1 uvicorn unilabos.layout_optimizer.server:app --host 0.0.0.0 --port 8000 --reload
# Run tests
pytest unilabos/layout_optimizer/tests/ -v
# Run LLM skill tests (needs API key)
ANTHROPIC_API_KEY=sk-... pytest unilabos/layout_optimizer/tests/test_llm_skill.py -v
```
**Log files**: All requests are logged to `unilabos/layout_optimizer/logs/{YYYYMMDD_HHMMSS}.log` at DEBUG level (frontend polling GET /scene/placements excluded).
### Dependencies
- Python ≥ 3.10
- scipy, numpy, fastapi, uvicorn, pydantic
- Optional: anthropic (for LLM skill tests)
- Optional: python-fcl (for real collision checking, not needed for mock mode)
### Environment Variables
| Variable | Default | Purpose |
|----------|---------|---------|
| `UNI_LAB_ASSETS_DIR` | `../uni-lab-assets` | Path to device 3D models |
| `UNI_LAB_OS_DEVICE_MESH_DIR` | `Uni-Lab-OS/unilabos/device_mesh/devices` | Registry device meshes |
| `LAYOUT_CHECKER_MODE` | `mock` | `mock` or `moveit` for checker selection |
| `LAYOUT_DEBUG` | (unset) | Set to `1` for DEBUG-level console logging (DE cost breakdown per generation) |
| `ANTHROPIC_API_KEY` | (none) | For LLM skill tests |
---
## 9. Known Limitations
1. **Mock reachability**: `MockReachabilityChecker` uses 100m fallback for unknown arm IDs — effectively "always reachable" for mock mode. Real arm reach requires `ros_checkers.py` with MoveIt2.
2. **No real LLM in tests**: `test_llm_skill.py` tests are skipped without `ANTHROPIC_API_KEY`. We verified with Claude Sonnet subagent that the skill doc produces correct output for PCR workflow scenarios.
3. **Opening data coverage**: 289/499 devices have opening direction annotations. Devices without openings default to local -Y as front with no alignment penalty.
4. **Single lab room**: No multi-room or corridor support yet. Lab is a single rectangle with optional rectangular obstacles.
5. **Intent interpreter is stateless**: It translates intents one-by-one with no cross-referencing between them. Duplicate/conflicting constraints are the LLM's responsibility to avoid.
6. **`align_weight` and `snap_cardinal` default to off**: `prefer_aligned` weight defaults to 0 (was `DEFAULT_WEIGHT_ANGLE=60`) and `snap_theta_safe` is opt-in via `snap_cardinal=True`. Both remain available when explicitly requested via `align_cardinal` intent or API param.
7. **Hybrid angle mode deprecated**: The angle-first hybrid mode (separate angle sweep + position-only DE) has been replaced by joint discrete mode as the default when `angle_granularity` is set. Joint mode snaps θ to the discrete lattice within the normal 3N DE loop.
---
## 10. Quick Verification (curl)
```bash
# 1. Health check
curl http://localhost:8000/health
# 2. Schema discovery
curl http://localhost:8000/interpret/schema | python3 -m json.tool
# 3. Interpret PCR workflow
curl -X POST http://localhost:8000/interpret \
-H "Content-Type: application/json" \
-d '{
"intents": [
{"intent": "reachable_by", "params": {"arm": "arm_slider", "targets": ["opentrons_liquid_handler", "inheco_odtc_96xl"]}, "description": "arm reaches targets"},
{"intent": "workflow_hint", "params": {"workflow": "pcr", "devices": ["thermo_orbitor_rs2_hotel", "opentrons_liquid_handler", "agilent_plateloc", "inheco_odtc_96xl"]}, "description": "PCR order"}
]
}' | python3 -m json.tool
# 4. Optimize (use constraints from step 3)
curl -X POST http://localhost:8000/optimize \
-H "Content-Type: application/json" \
-d '{
"devices": [
{"id": "thermo_orbitor_rs2_hotel", "name": "Plate Hotel"},
{"id": "arm_slider", "name": "Robot Arm", "device_type": "articulation"},
{"id": "opentrons_liquid_handler", "name": "Liquid Handler"},
{"id": "agilent_plateloc", "name": "Plate Sealer"},
{"id": "inheco_odtc_96xl", "name": "Thermal Cycler"}
],
"lab": {"width": 6.0, "depth": 4.0},
"constraints": [
{"type": "hard", "rule_name": "reachability", "params": {"arm_id": "arm_slider", "target_device_id": "opentrons_liquid_handler"}, "weight": 1.0},
{"type": "hard", "rule_name": "reachability", "params": {"arm_id": "arm_slider", "target_device_id": "inheco_odtc_96xl"}, "weight": 1.0},
{"type": "soft", "rule_name": "minimize_distance", "params": {"device_a": "thermo_orbitor_rs2_hotel", "device_b": "opentrons_liquid_handler"}, "weight": 3.0},
{"type": "soft", "rule_name": "minimize_distance", "params": {"device_a": "opentrons_liquid_handler", "device_b": "agilent_plateloc"}, "weight": 3.0},
{"type": "soft", "rule_name": "minimize_distance", "params": {"device_a": "agilent_plateloc", "device_b": "inheco_odtc_96xl"}, "weight": 3.0}
],
"workflow_edges": [
["thermo_orbitor_rs2_hotel", "opentrons_liquid_handler"],
["opentrons_liquid_handler", "agilent_plateloc"],
["agilent_plateloc", "inheco_odtc_96xl"]
],
"run_de": true,
"angle_granularity": 4,
"maxiter": 100,
"seed": 42
}' | python3 -m json.tool
```
---
## 11. Demo Setup
This section documents the device processing pipeline, test frontend, and LLM agent demo for the layout optimizer.
### 11.1 Device Processing Pipeline
How devices go from 3D meshes to collision footprints:
1. **Source data**:
- `uni-lab-assets/` repository: GLB/STL 3D models + XACRO robot descriptions
- `Uni-Lab-OS/device_mesh/devices/` registry: device metadata directories
2. **Extraction** (`extract_footprints.py`):
- Load meshes via `trimesh` (STL for geometry, GLB for display)
- Compute oriented bounding box (OBB): width, depth, height
- Apply GLB root node rotation to align with world frame
- Detect openings from XACRO `<joint type="fixed">` elements containing "socket" in name
- Compute opening direction: centroid of socket origins → cardinal direction mapping
- Manual overrides for devices with non-standard opening patterns (`MANUAL_OPENINGS` dict)
- Write results to `footprints.json` (499 devices, 183KB)
3. **Catalog merging** (`device_catalog.py`):
- Load `footprints.json` (OBB + openings)
- Load `uni-lab-assets/data.json` (asset tree structure)
- Load `Uni-Lab-OS/device_mesh/devices/` (registry devices)
- Merge: registry devices get priority for metadata, but assets' 3D model paths preferred
- Fallback sizes: `KNOWN_SIZES` dict provides manual dimensions when trimesh extraction fails
4. **Standalone filtering** (`server.py:_is_standalone_device`):
- Bbox >30cm = device (standalone equipment)
- Bbox <5cm = consumable (plates, tubes, tips)
- 5-30cm = keyword heuristic (check name for "plate", "tube", "tip", "rack")
### 11.2 Test Frontend (`static/lab3d.html`)
Interactive 3D lab layout visualization and design tool (1227 lines).
**Technology stack**:
- Three.js v0.169.0 (ES modules from esm.sh CDN)
- WebGL renderer with PCF soft shadow maps, ACES filmic tone mapping
- OrbitControls for camera interaction
**Features**:
- **Device library**: Left sidebar with search/filter, toggle between devices and consumables
- **Drag-to-add**: Click device in library → adds to scene with random position
- **Selected devices panel**: Right panel lists all placed devices, click to remove
- **Lab dimensions**: Width × Depth inputs (meters), collision margin slider
- **View modes**: 3D perspective (default) and top-down orthographic
- **Grid system**: 0.5m grid with lab boundary highlighting
- **Device visualization**: Box geometry with emissive materials, edge highlights, CSS2D labels
- **Opening markers**: Orange arrows and semi-transparent strips showing device access directions
- **Auto Layout button**: Calls `POST /optimize` with current devices + constraints
- **Scene polling**: 1-second polling of `GET /scene/placements` for agent-pushed updates (version-based change detection)
- **Smooth animation**: Lerp interpolation for device placement changes
**Backend integration**:
- `GET /devices` — Load device catalog on startup
- `POST /optimize` — Send devices + constraints, receive placements
- `POST /scene/lab` — Push lab dimensions when changed
- `GET /scene/placements` — Poll every 1s for agent-pushed updates
**Key JavaScript functions**:
- `loadDeviceCatalog()` — Fetch device list, build catalog with color pool
- `createDeviceMesh(deviceId, uuid)` — Create Three.js Group with body, edges, opening markers
- `addDevice(deviceId)` / `removeDevice(uuid)` — Manage selected devices
- `runLayout()` — Call backend `/optimize` or local bin packing fallback
- `animatePlacement(uuid, tx, tz, theta)` — Smooth lerp to target position
- `setView('3d' | 'top')` — Switch camera perspective
### 11.3 LLM Agent Demo (`llm_skill/demo_agent.md`)
LLM agent orchestration instructions for natural language lab layout design.
**Agent workflow**:
1. `GET /devices` — Fetch device catalog for context
2. Parse user natural language request
3. Build structured intents JSON (using `layout_intent_translator.md` skill)
4. `POST /interpret` — Translate intents to constraints
5. `POST /optimize` — Run layout optimization
6. `POST /scene/placements` — Push results to shared scene state
7. Frontend auto-updates via polling (no manual refresh needed)
**Example user requests**:
- "Design a PCR lab with robot arm automation, keep it compact"
- "Place liquid handler, thermal cycler, and plate sealer. Arm must reach all devices."
- "Add a plate hotel, make sure it's close to the liquid handler"
### 11.4 Running the Demo
```bash
# Start the server
uvicorn unilabos.layout_optimizer.server:app --host 0.0.0.0 --port 8000 --reload
# Open in browser
# http://localhost:8000/
# Use Claude Code with demo_agent.md skill to orchestrate via natural language
# The agent will call the API endpoints and push results to /scene/placements
# The frontend will automatically update via polling
```
**Demo flow**:
1. Open `http://localhost:8000/` in browser
2. Frontend loads device catalog and displays 3D scene
3. Use Claude Code with `demo_agent.md` skill to send natural language requests
4. Agent translates request → intents → constraints → optimization → scene update
5. Frontend polls `/scene/placements` every 1s and animates changes
6. User can manually add/remove devices or adjust lab size in the UI
7. Click "Auto Layout" to re-optimize with current devices

View File

@@ -0,0 +1,9 @@
"""Layout Optimizer — AI 实验室布局自动排布。
独立开发包,无 ROS 依赖。集成阶段合并到 Uni-Lab-OS。
"""
from .models import Constraint, Device, Lab, Opening, Placement
from .optimizer import optimize
__all__ = ["Device", "Lab", "Opening", "Placement", "Constraint", "optimize"]

View File

@@ -0,0 +1,66 @@
"""2 轴 sweep-and-prune 宽相碰撞检测。
对每个设备计算旋转后的 AABB先沿 x 轴排序并剪枝,
再用 y 轴交叠过滤。返回候选碰撞对(索引对列表),
供后续 OBB SAT 精确检测使用。
"""
from __future__ import annotations
from .models import Device, Placement
def sweep_and_prune_pairs(
devices: list[Device],
placements: list[Placement],
) -> list[tuple[int, int]]:
"""2 轴 sweep-and-prune返回 AABB 交叠的索引对。
Args:
devices: 设备列表,与 placements 一一对应。
placements: 布局位姿列表。
Returns:
候选碰撞对列表,每个元素为 (i, j)
i < j索引对应 placements 原始顺序。
"""
n = len(devices)
if n < 2:
return []
# --- 计算每个设备旋转后的 AABB ---
aabbs: list[tuple[float, float, float, float]] = []
for dev, pl in zip(devices, placements):
hw, hd = pl.rotated_bbox(dev)
aabbs.append((pl.x - hw, pl.x + hw, pl.y - hd, pl.y + hd))
# --- 按 xmin 排序,保留原始索引映射 ---
sorted_indices = sorted(range(n), key=lambda k: aabbs[k][0])
# --- 扫描 x 轴y 轴过滤 ---
candidates: list[tuple[int, int]] = []
for si in range(len(sorted_indices)):
i = sorted_indices[si]
x_min_i, x_max_i, y_min_i, y_max_i = aabbs[i]
for sj in range(si + 1, len(sorted_indices)):
j = sorted_indices[sj]
x_min_j, _x_max_j, y_min_j, y_max_j = aabbs[j]
# 由于按 xmin 排序x_min_j >= x_min_i
if x_min_j > x_max_i:
break # 后续设备 xmin 更大,不可能与 i 在 x 轴交叠
# x 轴交叠确认,检查 y 轴
if y_min_i <= y_max_j and y_min_j <= y_max_i:
# 保证输出 (min_idx, max_idx) 方便去重和测试
pair = (min(i, j), max(i, j))
candidates.append(pair)
return candidates
def broad_phase_device_pairs(
devices: list[Device],
placements: list[Placement],
) -> list[tuple[str, str]]:
"""返回候选碰撞对的 device_id 字符串元组列表。"""
index_pairs = sweep_and_prune_pairs(devices, placements)
return [(placements[i].device_id, placements[j].device_id) for i, j in index_pairs]

View File

@@ -0,0 +1,626 @@
"""约束体系:硬约束 / 软约束定义与统一评估。
硬约束违反 → cost = inf方案直接淘汰
软约束违反 → 加权 penalty 累加到 cost
"""
from __future__ import annotations
import logging
import math
from typing import TYPE_CHECKING
from .broad_phase import sweep_and_prune_pairs
from .models import Constraint, Device, Lab, Placement
from .obb import (
nearest_point_on_obb,
obb_corners,
obb_min_distance,
obb_penetration_depth,
segment_obb_intersection_length,
)
if TYPE_CHECKING:
from typing import Any
from .interfaces import CollisionChecker, ReachabilityChecker
logger = logging.getLogger(__name__)
# 归一化默认权重 — 1cm距离违规 ≈ 5°角度违规 的惩罚量级
DEFAULT_WEIGHT_DISTANCE: float = 100.0 # 1cm → penalty 1.0
DEFAULT_WEIGHT_ANGLE: float = 60.0 # 5° → penalty ~1.0
# 硬约束graduated模式下的惩罚倍数
HARD_MULTIPLIER: float = 5.0
# 优先级等级对应的权重乘数
PRIORITY_MULTIPLIERS: dict[str, float] = {
"critical": 5.0,
"high": 2.0,
"normal": 1.0,
"low": 0.5,
}
def evaluate_constraints(
devices: list[Device],
placements: list[Placement],
lab: Lab,
constraints: list[Constraint],
collision_checker: CollisionChecker,
reachability_checker: ReachabilityChecker | None = None,
*,
graduated: bool = True,
) -> float:
"""统一评估所有约束,返回总 cost。
Args:
devices: 设备列表(与 placements 一一对应)
placements: 当前布局方案
lab: 实验室平面图
constraints: 约束规则列表
collision_checker: 碰撞检测实例
reachability_checker: 可达性检测实例(可选)
graduated: True=比例惩罚DE优化用False=二值inf最终pass/fail用
Returns:
总 cost。硬约束违反在非graduated模式返回 inf否则为加权 penalty 之和。
"""
device_map = {d.id: d for d in devices}
placement_map = {p.device_id: p for p in placements}
total_cost = 0.0
for c in constraints:
cost = _evaluate_single(
c, device_map, placement_map, lab, collision_checker, reachability_checker,
graduated=graduated,
)
if math.isinf(cost):
return math.inf
total_cost += cost
return total_cost
def evaluate_default_hard_constraints(
devices: list[Device],
placements: list[Placement],
lab: Lab,
collision_checker: CollisionChecker,
*,
graduated: bool = True,
collision_weight: float = DEFAULT_WEIGHT_DISTANCE * HARD_MULTIPLIER, # 500
boundary_weight: float = DEFAULT_WEIGHT_DISTANCE * HARD_MULTIPLIER, # 500
) -> float:
"""评估默认硬约束(碰撞 + 边界),无需显式声明约束列表。
始终生效,用于 cost function 的基础检查。
When graduated=True (default), returns a penalty proportional to the
severity of each violation instead of binary inf. This gives DE a
smooth gradient so it can fix specific collision pairs instead of
discarding near-optimal layouts entirely.
When graduated=False, uses the legacy binary inf behaviour.
"""
if not graduated:
return _evaluate_hard_binary(devices, placements, lab, collision_checker)
device_map = {d.id: d for d in devices}
cost = 0.0
# Graduated collision penalty: 2 轴 sweep-and-prune 宽相 + OBB SAT 精确检测
candidate_pairs = sweep_and_prune_pairs(devices, placements)
for i, j in candidate_pairs:
di, dj = device_map[placements[i].device_id], device_map[placements[j].device_id]
ci = obb_corners(placements[i].x, placements[i].y,
di.bbox[0], di.bbox[1], placements[i].theta)
cj = obb_corners(placements[j].x, placements[j].y,
dj.bbox[0], dj.bbox[1], placements[j].theta)
depth = obb_penetration_depth(ci, cj)
if depth > 0:
cost += collision_weight * depth
# Graduated boundary penalty: sum of overshoot distances (rotation-aware)
for p in placements:
dev = device_map[p.device_id]
hw, hd = p.rotated_bbox(dev)
# How far each edge exceeds the lab boundary
overshoot = 0.0
overshoot += max(0.0, hw - p.x) # left wall
overshoot += max(0.0, (p.x + hw) - lab.width) # right wall
overshoot += max(0.0, hd - p.y) # bottom wall
overshoot += max(0.0, (p.y + hd) - lab.depth) # top wall
cost += boundary_weight * overshoot
return cost
def _evaluate_hard_binary(
devices: list[Device],
placements: list[Placement],
lab: Lab,
collision_checker: CollisionChecker,
) -> float:
"""Legacy binary hard-constraint evaluation (inf or 0)."""
checker_placements = _to_checker_format(devices, placements)
collisions = collision_checker.check(checker_placements)
if collisions:
return math.inf
if hasattr(collision_checker, "check_bounds"):
oob = collision_checker.check_bounds(checker_placements, lab.width, lab.depth)
if oob:
return math.inf
return 0.0
def _evaluate_single(
constraint: Constraint,
device_map: dict[str, Device],
placement_map: dict[str, Placement],
lab: Lab,
collision_checker: CollisionChecker,
reachability_checker: ReachabilityChecker | None,
*,
graduated: bool = True,
) -> float:
"""评估单条约束规则。
graduated=True 时硬约束返回比例惩罚DE用
graduated=False 时硬约束返回 inf最终 pass/fail
"""
rule = constraint.rule_name
params = constraint.params
is_hard = constraint.type == "hard"
effective_weight = constraint.weight
if rule == "no_collision":
checker_placements = _to_checker_format_from_maps(device_map, placement_map)
collisions = collision_checker.check(checker_placements)
if collisions:
if is_hard and not graduated:
return math.inf
w = effective_weight * (HARD_MULTIPLIER if is_hard else 1.0)
return w * len(collisions)
return 0.0
if rule == "within_bounds":
checker_placements = _to_checker_format_from_maps(device_map, placement_map)
if hasattr(collision_checker, "check_bounds"):
oob = collision_checker.check_bounds(
checker_placements, lab.width, lab.depth
)
if oob:
if is_hard and not graduated:
return math.inf
w = effective_weight * (HARD_MULTIPLIER if is_hard else 1.0)
return w * len(oob)
return 0.0
if rule == "distance_less_than":
a_id, b_id = params["device_a"], params["device_b"]
max_dist = params["distance"]
da, db = device_map.get(a_id), device_map.get(b_id)
pa, pb = placement_map.get(a_id), placement_map.get(b_id)
missing_cost = _missing_reference_cost(constraint, placement_map, a_id, b_id)
if missing_cost is not None:
return missing_cost
if da and db:
dist = _device_distance_obb(da, pa, db, pb)
else:
dist = _device_distance_center(pa, pb) or 0.0
if dist > max_dist:
if is_hard and not graduated:
return math.inf
w = effective_weight * (HARD_MULTIPLIER if is_hard else 1.0)
return w * (dist - max_dist)
return 0.0
if rule == "distance_greater_than":
a_id, b_id = params["device_a"], params["device_b"]
min_dist = params["distance"]
da, db = device_map.get(a_id), device_map.get(b_id)
pa, pb = placement_map.get(a_id), placement_map.get(b_id)
missing_cost = _missing_reference_cost(constraint, placement_map, a_id, b_id)
if missing_cost is not None:
return missing_cost
if da and db:
dist = _device_distance_obb(da, pa, db, pb)
else:
dist = _device_distance_center(pa, pb) or 0.0
if dist < min_dist:
if is_hard and not graduated:
return math.inf
w = effective_weight * (HARD_MULTIPLIER if is_hard else 1.0)
return w * (min_dist - dist)
return 0.0
if rule == "minimize_distance":
a_id, b_id = params["device_a"], params["device_b"]
da, db = device_map.get(a_id), device_map.get(b_id)
pa, pb = placement_map.get(a_id), placement_map.get(b_id)
missing_cost = _missing_reference_cost(constraint, placement_map, a_id, b_id)
if missing_cost is not None:
return missing_cost
if da and db:
dist = _device_distance_obb(da, pa, db, pb)
else:
dist = _device_distance_center(pa, pb) or 0.0
return effective_weight * dist
if rule == "maximize_distance":
a_id, b_id = params["device_a"], params["device_b"]
da, db = device_map.get(a_id), device_map.get(b_id)
pa, pb = placement_map.get(a_id), placement_map.get(b_id)
missing_cost = _missing_reference_cost(constraint, placement_map, a_id, b_id)
if missing_cost is not None:
return missing_cost
if da and db:
dist = _device_distance_obb(da, pa, db, pb)
else:
dist = _device_distance_center(pa, pb) or 0.0
max_possible = math.sqrt(lab.width**2 + lab.depth**2)
return effective_weight * (max_possible - dist)
if rule == "min_spacing":
min_gap = params.get("min_gap", 0.0)
all_placements = list(placement_map.values())
total_penalty = 0.0
for i in range(len(all_placements)):
for j in range(i + 1, len(all_placements)):
pi, pj = all_placements[i], all_placements[j]
di = device_map.get(pi.device_id)
dj = device_map.get(pj.device_id)
if di and dj:
dist = _device_distance_obb(di, pi, dj, pj)
else:
dist = _device_distance_center(pi, pj) or 0.0
if dist < min_gap:
total_penalty += (min_gap - dist)
if total_penalty > 0:
if is_hard and not graduated:
return math.inf
w = effective_weight * (HARD_MULTIPLIER if is_hard else 1.0)
return w * total_penalty
return 0.0
if rule == "reachability":
if reachability_checker is None:
return 0.0
arm_id = params["arm_id"]
target_device_id = params["target_device_id"]
arm_p = placement_map.get(arm_id)
target_p = placement_map.get(target_device_id)
missing_cost = _missing_reference_cost(
constraint, placement_map, arm_id, target_device_id,
)
if missing_cost is not None:
return missing_cost
arm_dev = device_map.get(arm_id)
target_dev = device_map.get(target_device_id)
# opening surface center → nearest point on arm OBB
if arm_dev and target_dev:
opening_pt = _opening_surface_center(target_dev, target_p)
arm_corners = obb_corners(
arm_p.x, arm_p.y, arm_dev.bbox[0], arm_dev.bbox[1], arm_p.theta,
)
nearest = nearest_point_on_obb(opening_pt[0], opening_pt[1], arm_corners)
dist = math.sqrt((opening_pt[0] - nearest[0])**2 + (opening_pt[1] - nearest[1])**2)
else:
opening_pt = (target_p.x, target_p.y)
nearest = (arm_p.x, arm_p.y)
dist = _device_distance_center(arm_p, target_p) or 0.0
# 交叉惩罚始终计算soft, 不依赖可达性结果)
crossing_cost = _crossing_penalty(
opening_pt, nearest,
arm_id, target_device_id,
device_map, placement_map,
)
arm_pose = {"x": arm_p.x, "y": arm_p.y, "theta": arm_p.theta}
target_point = {"x": target_p.x, "y": target_p.y, "z": 0.0}
target_point["_obb_dist"] = dist
if not reachability_checker.is_reachable(arm_id, arm_pose, target_point):
if is_hard and not graduated:
return math.inf
# Graduated: overshoot penalty + crossing cost
max_reach = reachability_checker.arm_reach.get(arm_id, 2.0)
overshoot = max(0.0, dist - max_reach)
w = effective_weight * (HARD_MULTIPLIER if is_hard else 1.0)
return w * overshoot * 10.0 + crossing_cost
return crossing_cost
if rule == "prefer_aligned":
alignment_cost = sum(
(1 - math.cos(4 * p.theta)) / 2 for p in placement_map.values()
)
if is_hard:
if not graduated:
return math.inf if alignment_cost > 1e-6 else 0.0
return HARD_MULTIPLIER * effective_weight * alignment_cost
return effective_weight * alignment_cost
if rule == "prefer_seeder_orientation":
target_thetas = params.get("target_thetas", {})
cost = 0.0
for dev_id, target in target_thetas.items():
p = placement_map.get(dev_id)
if p is None:
continue
# Circular distance: (1 - cos(diff)) / 2 gives 0..1 range
diff = p.theta - target
cost += (1 - math.cos(diff)) / 2
return effective_weight * cost
if rule == "prefer_orientation_mode":
mode = params.get("mode", "outward")
center_x = lab.width / 2
center_y = lab.depth / 2
cost = 0.0
for dev_id, p in placement_map.items():
dev = device_map.get(dev_id)
if dev is None:
continue
target = _desired_theta(
p.x, p.y, center_x, center_y, dev, mode,
)
if target is None:
continue
diff = p.theta - target
cost += (1 - math.cos(diff)) / 2
return effective_weight * cost
# 未知约束类型,忽略
return 0.0
def _desired_theta(
x: float, y: float,
center_x: float, center_y: float,
device: Device, mode: str,
) -> float | None:
"""Compute desired theta for outward/inward facing at the given position."""
dx = x - center_x
dy = y - center_y
if abs(dx) < 1e-9 and abs(dy) < 1e-9:
return None # At center, no preferred direction
angle_to_device = math.atan2(dy, dx)
front = device.openings[0].direction if device.openings else (0.0, -1.0)
front_angle = math.atan2(front[1], front[0])
if mode == "outward":
target = angle_to_device
elif mode == "inward":
target = angle_to_device + math.pi
else:
return None
return (target - front_angle) % (2 * math.pi)
def _device_distance_center(a: Placement | None, b: Placement | None) -> float | None:
"""计算两设备中心的欧几里得距离(后备方法)。"""
if a is None or b is None:
return None
return math.sqrt((a.x - b.x) ** 2 + (a.y - b.y) ** 2)
def _device_distance_obb(
device_a: Device, placement_a: Placement,
device_b: Device, placement_b: Placement,
) -> float:
"""Minimum edge-to-edge distance between two devices using OBB."""
corners_a = obb_corners(
placement_a.x, placement_a.y,
device_a.bbox[0], device_a.bbox[1],
placement_a.theta,
)
corners_b = obb_corners(
placement_b.x, placement_b.y,
device_b.bbox[0], device_b.bbox[1],
placement_b.theta,
)
return obb_min_distance(corners_a, corners_b)
def _to_checker_format(
devices: list[Device], placements: list[Placement]
) -> list[dict]:
"""转换为 CollisionChecker.check() 接受的格式。"""
device_map = {d.id: d for d in devices}
result = []
for p in placements:
dev = device_map.get(p.device_id)
if dev is None:
continue
result.append({"id": p.device_id, "bbox": dev.bbox, "pos": (p.x, p.y, p.theta)})
return result
def _to_checker_format_from_maps(
device_map: dict[str, Device], placement_map: dict[str, Placement]
) -> list[dict]:
"""从 map 转换为 CollisionChecker.check() 接受的格式。"""
result = []
for dev_id, p in placement_map.items():
dev = device_map.get(dev_id)
if dev is None:
continue
result.append({"id": dev_id, "bbox": dev.bbox, "pos": (p.x, p.y, p.theta)})
return result
def _opening_surface_center(
device: Device, placement: Placement,
) -> tuple[float, float]:
"""Return the world-space center of the device's opening surface.
Computes where the opening direction intersects the device's bbox boundary,
then transforms to world coordinates. For a device facing away from the arm,
this point is on the far side — making the distance to the arm larger,
which naturally penalizes wrong orientation.
"""
front = device.openings[0].direction if device.openings else (0.0, -1.0)
dx, dy = front
w, h = device.bbox
# Scale factor to reach bbox edge in the opening direction
scales = []
if abs(dx) > 1e-9:
scales.append((w / 2) / abs(dx))
if abs(dy) > 1e-9:
scales.append((h / 2) / abs(dy))
scale = min(scales) if scales else 0.0
# Opening center in local frame
local_x = dx * scale
local_y = dy * scale
# Rotate to world frame and translate
cos_t = math.cos(placement.theta)
sin_t = math.sin(placement.theta)
world_x = placement.x + local_x * cos_t - local_y * sin_t
world_y = placement.y + local_x * sin_t + local_y * cos_t
return (world_x, world_y)
def evaluate_default_hard_constraints_breakdown(
devices: list[Device],
placements: list[Placement],
lab: Lab,
collision_checker: CollisionChecker,
*,
collision_weight: float = DEFAULT_WEIGHT_DISTANCE * HARD_MULTIPLIER,
boundary_weight: float = DEFAULT_WEIGHT_DISTANCE * HARD_MULTIPLIER,
) -> dict[str, float]:
"""与 evaluate_default_hard_constraints 逻辑相同,但返回分项明细。"""
device_map = {d.id: d for d in devices}
collision_cost = 0.0
boundary_cost = 0.0
candidate_pairs = sweep_and_prune_pairs(devices, placements)
for i, j in candidate_pairs:
di, dj = device_map[placements[i].device_id], device_map[placements[j].device_id]
ci = obb_corners(placements[i].x, placements[i].y,
di.bbox[0], di.bbox[1], placements[i].theta)
cj = obb_corners(placements[j].x, placements[j].y,
dj.bbox[0], dj.bbox[1], placements[j].theta)
depth = obb_penetration_depth(ci, cj)
if depth > 0:
collision_cost += collision_weight * depth
for p in placements:
dev = device_map[p.device_id]
hw, hd = p.rotated_bbox(dev)
overshoot = 0.0
overshoot += max(0.0, hw - p.x)
overshoot += max(0.0, (p.x + hw) - lab.width)
overshoot += max(0.0, hd - p.y)
overshoot += max(0.0, (p.y + hd) - lab.depth)
boundary_cost += boundary_weight * overshoot
return {
"collision": collision_cost,
"boundary": boundary_cost,
"total": collision_cost + boundary_cost,
"collision_weight": collision_weight,
"boundary_weight": boundary_weight,
}
def evaluate_constraints_breakdown(
devices: list[Device],
placements: list[Placement],
lab: Lab,
constraints: list[Constraint],
collision_checker: CollisionChecker,
reachability_checker: ReachabilityChecker | None = None,
) -> list[dict[str, Any]]:
"""与 evaluate_constraints 逻辑相同,但返回每条约束的分项明细。"""
device_map = {d.id: d for d in devices}
placement_map = {p.device_id: p for p in placements}
results = []
for c in constraints:
cost = _evaluate_single(
c, device_map, placement_map, lab, collision_checker, reachability_checker,
graduated=True,
)
results.append({
"name": _constraint_display_name(c),
"rule": c.rule_name,
"type": c.type,
"cost": cost,
"weight": c.weight,
})
return results
def _missing_reference_cost(
constraint: Constraint,
placement_map: dict[str, Placement],
*device_ids: str,
) -> float | None:
"""当约束引用不存在的设备时返回对应 cost。"""
missing = sorted({device_id for device_id in device_ids if device_id not in placement_map})
if not missing:
return None
logger.warning(
"Constraint %s references missing device IDs: %s",
constraint.rule_name,
", ".join(missing),
)
if constraint.type == "hard":
return math.inf
return 0.0
def _constraint_display_name(c: Constraint) -> str:
"""为约束生成可读的显示名称。"""
params = c.params
if c.rule_name in (
"distance_less_than", "distance_greater_than",
"minimize_distance", "maximize_distance",
):
return f"{c.rule_name}({params.get('device_a', '?')}, {params.get('device_b', '?')})"
if c.rule_name == "reachability":
return f"reachability({params.get('arm_id', '?')}, {params.get('target_device_id', '?')})"
if c.rule_name == "min_spacing":
return f"min_spacing(gap={params.get('min_gap', '?')})"
if c.rule_name == "prefer_orientation_mode":
return f"prefer_orientation_mode({params.get('mode', '?')})"
return c.rule_name
def _crossing_penalty(
opening_pt: tuple[float, float],
arm_nearest_pt: tuple[float, float],
arm_id: str,
target_id: str,
device_map: dict[str, Device],
placement_map: dict[str, Placement],
) -> float:
"""交叉惩罚:其他设备 OBB 遮挡 opening→arm 路径的长度加权 penalty。
Soft penalty权重 = DEFAULT_WEIGHT_DISTANCE * 穿过各遮挡设备 OBB 的线段长度之和。
始终生效(不论可达性是否通过),为 DE 提供清晰的梯度信号。
"""
cost = 0.0
for dev_id, p in placement_map.items():
if dev_id == arm_id or dev_id == target_id:
continue
dev = device_map.get(dev_id)
if dev is None:
continue
corners = obb_corners(p.x, p.y, dev.bbox[0], dev.bbox[1], p.theta)
crossing_len = segment_obb_intersection_length(opening_pt, arm_nearest_pt, corners)
cost += DEFAULT_WEIGHT_DISTANCE * crossing_len
return cost

View File

@@ -0,0 +1,302 @@
"""双源设备目录:从 uni-lab-assets 和 Uni-Lab-OS registry 加载设备。
数据流:
footprints.json (离线提取) + data.json (资产树) + registry device_mesh dirs
→ merge → Device 列表
footprints.json 由 extract_footprints.py 生成,包含碰撞包围盒、开口方向等。
"""
from __future__ import annotations
from collections import Counter
import json
import logging
from pathlib import Path
from .models import Device, Opening
logger = logging.getLogger(__name__)
# 默认路径(相对于本文件)
_THIS_DIR = Path(__file__).resolve().parent
_DEFAULT_FOOTPRINTS = _THIS_DIR / "footprints.json"
# 手动后备尺寸trimesh 不可用时)
KNOWN_SIZES: dict[str, tuple[float, float]] = {
"elite_cs66_arm": (0.20, 0.20),
"elite_cs612_arm": (0.20, 0.20),
"ot2": (0.62, 0.50),
"agilent_bravo": (0.80, 0.65),
"thermo_orbitor_rs2": (0.45, 0.55),
"hplc_station": (0.60, 0.50),
"1_3m_hamilton_table": (1.30, 0.75),
}
DEFAULT_BBOX: tuple[float, float] = (0.6, 0.4)
# ---------- footprints.json 加载 ----------
_footprints_cache: dict[str, dict] | None = None
def load_footprints(path: str | Path = _DEFAULT_FOOTPRINTS) -> dict[str, dict]:
"""加载 footprints.json 并缓存。"""
global _footprints_cache
if _footprints_cache is not None:
return _footprints_cache
p = Path(path)
if not p.exists():
logger.warning("footprints.json not found at %s", p)
_footprints_cache = {}
return _footprints_cache
with open(p) as f:
_footprints_cache = json.load(f)
logger.info("Loaded %d footprints from %s", len(_footprints_cache), p)
return _footprints_cache
def reset_footprints_cache() -> None:
"""清除缓存(测试用)。"""
global _footprints_cache
_footprints_cache = None
# ---------- 从 footprints 构建 Device ----------
def _footprint_to_device(
device_id: str,
fp: dict,
name: str = "",
models_url_prefix: str = "/models",
) -> Device:
"""从 footprints.json 条目创建 Device。"""
bbox = tuple(fp.get("bbox", DEFAULT_BBOX))
openings = [
Opening(direction=tuple(o["direction"]), label=o.get("label", ""))
for o in fp.get("openings", [])
]
model_file = fp.get("model_file", "")
model_path = f"{models_url_prefix}/{device_id}/{model_file}" if model_file else ""
model_type = fp.get("model_type", "")
thumb_file = fp.get("thumbnail_file", "")
thumbnail_url = f"{models_url_prefix}/{device_id}/{thumb_file}" if thumb_file else ""
return Device(
id=device_id,
name=name or device_id.replace("_", " ").title(),
bbox=bbox,
device_type="articulation" if "robot" in device_id or "arm" in device_id or "flex" in device_id else "static",
height=fp.get("height", 0.4),
origin_offset=tuple(fp.get("origin_offset", [0.0, 0.0])),
openings=openings,
source=fp.get("source", "manual"),
model_path=model_path,
model_type=model_type,
thumbnail_url=thumbnail_url,
)
# ---------- 从 data.json 加载 ----------
def load_devices_from_assets(
data_json_path: str | Path,
footprints: dict[str, dict] | None = None,
models_url_prefix: str = "/models",
) -> list[Device]:
"""从 uni-lab-assets 的 data.json 加载设备列表。
如果设备在 footprints 中有条目,使用真实尺寸;否则使用默认值。
"""
path = Path(data_json_path)
if not path.exists():
logger.warning("data.json not found at %s, returning empty list", path)
return []
if footprints is None:
footprints = load_footprints()
with open(path) as f:
data = json.load(f)
devices: list[Device] = []
_flatten_tree(data, devices, footprints, models_url_prefix)
return devices
def _flatten_tree(
nodes: list[dict],
result: list[Device],
footprints: dict[str, dict],
models_url_prefix: str,
) -> None:
"""递归遍历树形结构,提取叶节点为 Device。"""
for node in nodes:
if "children" in node:
_flatten_tree(node["children"], result, footprints, models_url_prefix)
elif "id" in node:
device_id = node["id"]
name = node.get("label", device_id)
if device_id in footprints:
dev = _footprint_to_device(
device_id, footprints[device_id], name, models_url_prefix
)
else:
bbox = KNOWN_SIZES.get(device_id, DEFAULT_BBOX)
dev = Device(id=device_id, name=name, bbox=bbox, source="assets")
result.append(dev)
# ---------- 从 registry 加载 ----------
def load_devices_from_registry(
device_mesh_dir: str | Path,
footprints: dict[str, dict] | None = None,
models_url_prefix: str = "/models",
) -> list[Device]:
"""从 Uni-Lab-OS device_mesh/devices/ 加载 registry 设备。"""
d = Path(device_mesh_dir)
if not d.exists():
logger.warning("Registry dir not found at %s", d)
return []
if footprints is None:
footprints = load_footprints()
devices: list[Device] = []
for entry in sorted(d.iterdir()):
if not entry.is_dir():
continue
device_id = entry.name
if device_id in footprints:
dev = _footprint_to_device(
device_id, footprints[device_id], models_url_prefix=models_url_prefix
)
dev.source = "registry"
else:
bbox = KNOWN_SIZES.get(device_id, DEFAULT_BBOX)
dev = Device(id=device_id, name=device_id.replace("_", " ").title(), bbox=bbox, source="registry")
devices.append(dev)
return devices
# ---------- 合并与去重 ----------
def merge_device_lists(
registry_devices: list[Device],
asset_devices: list[Device],
) -> list[Device]:
"""合并双源设备列表registry 优先。
对于同时存在于两个源的设备,使用 registry 条目的元数据,
但优先使用 assets 的 3D 模型路径和缩略图。
"""
merged: dict[str, Device] = {}
for dev in asset_devices:
merged[dev.id] = dev
for dev in registry_devices:
if dev.id in merged:
# registry 元数据优先,但保留 assets 的模型/缩略图
asset_dev = merged[dev.id]
dev.model_path = dev.model_path or asset_dev.model_path
dev.model_type = dev.model_type or asset_dev.model_type
dev.thumbnail_url = dev.thumbnail_url or asset_dev.thumbnail_url
if dev.bbox == DEFAULT_BBOX and asset_dev.bbox != DEFAULT_BBOX:
dev.bbox = asset_dev.bbox
dev.height = asset_dev.height
dev.origin_offset = asset_dev.origin_offset
dev.openings = asset_dev.openings
dev.source = "registry"
merged[dev.id] = dev
return list(merged.values())
# ---------- 统一解析器 ----------
def resolve_device(
device_id: str,
footprints: dict[str, dict] | None = None,
models_url_prefix: str = "/models",
) -> Device | None:
"""按 ID 查找单个设备。先查 footprints再查 KNOWN_SIZES。"""
if footprints is None:
footprints = load_footprints()
if device_id in footprints:
return _footprint_to_device(
device_id, footprints[device_id], models_url_prefix=models_url_prefix
)
if device_id in KNOWN_SIZES:
bbox = KNOWN_SIZES[device_id]
return Device(id=device_id, name=device_id.replace("_", " ").title(), bbox=bbox, source="manual")
return None
# ---------- 向后兼容 ----------
def create_devices_from_list(
device_specs: list[dict],
) -> list[Device]:
"""从 API 请求中的设备列表创建 Device 对象(向后兼容)。
Args:
device_specs: [{"id": str, "name": str, "size": [w, d], "uuid": str}, ...]
size 可选,缺失时使用 footprints 或默认值。
"""
footprints = load_footprints()
devices = []
catalog_counts = Counter(spec["id"] for spec in device_specs)
catalog_seen: Counter[str] = Counter()
for spec in device_specs:
catalog_id = spec["id"]
catalog_seen[catalog_id] += 1
instance_idx = catalog_seen[catalog_id]
if catalog_counts[catalog_id] > 1 and instance_idx > 1:
dev_id = f"{catalog_id}#{instance_idx}"
else:
dev_id = catalog_id
size = spec.get("size")
if size:
bbox = (float(size[0]), float(size[1]))
elif catalog_id in footprints:
bbox = tuple(footprints[catalog_id].get("bbox", DEFAULT_BBOX))
else:
bbox = KNOWN_SIZES.get(catalog_id, DEFAULT_BBOX)
openings = []
if catalog_id in footprints:
openings = [
Opening(direction=tuple(o["direction"]), label=o.get("label", ""))
for o in footprints[catalog_id].get("openings", [])
]
devices.append(
Device(
id=dev_id,
name=spec.get("name", catalog_id),
bbox=bbox,
device_type=spec.get("device_type", "static"),
openings=openings,
uuid=spec.get("uuid", ""),
)
)
return devices

View File

@@ -0,0 +1,559 @@
"""从 STL/GLB 网格提取设备足迹(碰撞包围盒)。
运行方式:
conda activate phase3
python -m layout_optimizer.extract_footprints
输出 footprints.json 供 device_catalog.py 和 2D 规划器使用。
GLB root node rotation:
每个设备的 GLB 文件包含根节点旋转四元数,定义 STL 原生坐标到 glTF Y-up
约定的轴映射。extract_one_device() 读取 GLB JSON提取旋转矩阵
应用到 STL 包围盒后按 glTF 约定提取 2D 足迹 (X=width, Z=depth, Y=height)。
GLB scale 不应用——STL 文件已是米制坐标。
"""
from __future__ import annotations
import argparse
import json
import logging
import math
import os
import re
import struct
import xml.etree.ElementTree as ET
from pathlib import Path
logger = logging.getLogger(__name__)
# 测试设备的开口方向(手动标注)
# direction 为设备局部坐标系中的单位向量,[0, -1] 表示设备正前方
MANUAL_OPENINGS: dict[str, list[dict]] = {
"agilent_bravo": [{"direction": [0, -1], "label": "front_plate_slot"}],
"opentrons_liquid_handler": [{"direction": [0, -1], "label": "front_deck"}],
"opentrons_flex": [{"direction": [0, -1], "label": "front_deck"}],
"thermo_orbitor_rs2_hotel": [{"direction": [0, -1], "label": "front_door"}],
"hamilton_star": [{"direction": [0, -1], "label": "front_deck"}],
"tecan_spark_plate_reader": [{"direction": [0, -1], "label": "front_slot"}],
"highres_bio_plate_hotel_12": [{"direction": [0, -1], "label": "front_shelf"}],
"beckman_coulter_orbital_shaker_alp": [],
"liconic_str44_incubator": [{"direction": [0, -1], "label": "front_door"}],
"elite_robot": [], # 机械臂,无开口
}
# 手动尺寸后备trimesh 提取失败时使用)
FALLBACK_SIZES: dict[str, tuple[float, float, float]] = {
"elite_robot": (0.20, 0.20, 0.10),
"elite_cs66_arm": (0.20, 0.20, 0.10),
"elite_cs612_arm": (0.20, 0.20, 0.10),
}
def extract_openings_from_xacro(
xacro_path: Path,
bbox_center_xy: tuple[float, float],
bbox_size_xy: tuple[float, float],
) -> list[dict]:
"""从 XACRO 文件自动提取设备开口方向。
解析 fixed joint 中包含 "socket" 的关节,计算其 XY 质心,与包围盒中心比较,
映射到最近的基本方向。
Args:
xacro_path: modal.xacro 文件路径
bbox_center_xy: 包围盒 XY 中心 (cx, cy)
bbox_size_xy: 包围盒 XY 尺寸 (w, d)
Returns:
[{"direction": [dx, dy], "label": "auto_xacro"}] 或 []
"""
# --- 方法1: ElementTree 解析(忽略 xacro 命名空间) ---
socket_positions: list[tuple[float, float]] = []
try:
xacro_text = xacro_path.read_text(encoding="utf-8", errors="replace")
# 去掉 xacro 命名空间前缀,避免 ElementTree 解析失败
xacro_text_clean = re.sub(r'\bxacro:', '', xacro_text)
root = ET.fromstring(xacro_text_clean)
for joint in root.iter("joint"):
joint_name = joint.get("name", "")
joint_type = joint.get("type", "")
if "socket" not in joint_name.lower():
continue
if joint_type != "fixed":
continue
origin = joint.find("origin")
if origin is None:
continue
xyz_str = origin.get("xyz", "")
if not xyz_str:
continue
parts = xyz_str.split()
if len(parts) < 2:
continue
try:
x = float(parts[0])
y = float(parts[1])
socket_positions.append((x, y))
except ValueError:
continue
except ET.ParseError as e:
logger.debug("ElementTree parse error for %s: %s — falling back to regex", xacro_path, e)
# --- 方法2: 正则表达式后备(当 ElementTree 失败或无结果时) ---
if not socket_positions:
try:
xacro_text = xacro_path.read_text(encoding="utf-8", errors="replace")
# 匹配包含 "socket" 的 joint 块,提取 origin xyz
joint_blocks = re.findall(
r'<joint\s[^>]*name=["\'][^"\']*socket[^"\']*["\'][^>]*>.*?</joint>',
xacro_text,
flags=re.IGNORECASE | re.DOTALL,
)
for block in joint_blocks:
# 只处理 fixed 类型
if 'type="fixed"' not in block and "type='fixed'" not in block:
continue
xyz_match = re.search(r'<origin[^>]*xyz=["\']([^"\']+)["\']', block)
if not xyz_match:
continue
parts = xyz_match.group(1).split()
if len(parts) < 2:
continue
try:
x = float(parts[0])
y = float(parts[1])
socket_positions.append((x, y))
except ValueError:
continue
except Exception as e:
logger.debug("Regex fallback also failed for %s: %s", xacro_path, e)
if not socket_positions:
return []
# 计算 socket XY 质心
cx_sock = sum(p[0] for p in socket_positions) / len(socket_positions)
cy_sock = sum(p[1] for p in socket_positions) / len(socket_positions)
# 方向向量:从包围盒中心指向 socket 质心
dx = cx_sock - bbox_center_xy[0]
dy = cy_sock - bbox_center_xy[1]
# 如果 socket 质心非常靠近包围盒中心(<5% 尺寸),判断为顶部装载
threshold = 0.05 * max(bbox_size_xy[0], bbox_size_xy[1], 1e-6)
if math.hypot(dx, dy) < threshold:
logger.debug(
"%s: socket centroid too close to bbox center (dist=%.4f, threshold=%.4f) → top-loading",
xacro_path.parent.name,
math.hypot(dx, dy),
threshold,
)
return []
# 映射到最近基本方向
# socket 质心指示交互区在设备哪一侧,而 opening direction 是从该面
# 向外的法线方向(与质心偏移同向),这里的 dx/dy 已经是从包围盒中心
# 指向 socket 区域的方向,即 opening 朝外的方向
# 注意:在 uni-lab-assets 中,大多数设备 front 在 Y=0 而 body 在 -Y
# 所以 socket 集中在 +Y 侧(靠近 Y=0 前端bbox 中心在 -Y/2。
# 方向 center→socket = +Y但 "opening faces front" 在手动标注中
# 写作 [0, -1](法线向外=向操作者方向)。
# 因此需要取反opening direction = -(center→socket)
if abs(dx) >= abs(dy):
cardinal = [-1, 0] if dx > 0 else [1, 0]
else:
cardinal = [0, -1] if dy > 0 else [0, 1]
logger.debug(
"%s: %d socket joints → centroid=(%.3f, %.3f) dir=%s",
xacro_path.parent.name,
len(socket_positions),
cx_sock,
cy_sock,
cardinal,
)
return [{"direction": cardinal, "label": "auto_xacro"}]
def _find_mesh_files(device_dir: Path) -> list[Path]:
"""查找设备目录中的所有 STL/GLB 网格文件。"""
mesh_files: list[Path] = []
meshes_dir = device_dir / "meshes"
if not meshes_dir.exists():
return mesh_files
# uni-lab-assets 结构: meshes/*.stl, meshes/*.glb
for f in meshes_dir.iterdir():
if f.suffix.lower() in (".stl", ".glb"):
mesh_files.append(f)
# registry 结构: meshes/<variant>/collision/*.stl
if not mesh_files:
for variant_dir in meshes_dir.iterdir():
if variant_dir.is_dir():
collision_dir = variant_dir / "collision"
if collision_dir.exists():
for f in collision_dir.iterdir():
if f.suffix.lower() == ".stl":
mesh_files.append(f)
if mesh_files:
break # 使用找到的第一个变体
return sorted(mesh_files)
def _find_best_model_file(device_dir: Path) -> tuple[str, str]:
"""找到最佳可展示的模型文件。优先 GLB > STL。
Returns:
(relative_path, model_type) e.g. ("meshes/0_base.glb", "gltf")
"""
meshes_dir = device_dir / "meshes"
if not meshes_dir.exists():
return "", ""
glbs = sorted(meshes_dir.glob("*.glb"))
if glbs:
return f"meshes/{glbs[0].name}", "gltf"
stls = sorted(f for f in meshes_dir.glob("*.stl") if f.suffix == ".stl")
if not stls:
stls = sorted(f for f in meshes_dir.glob("*.STL"))
if stls:
return f"meshes/{stls[0].name}", "stl"
return "", ""
def _find_thumbnail(device_dir: Path) -> str:
"""查找设备目录中的第一个 PNG 缩略图。"""
pngs = sorted(device_dir.glob("*.png"))
if pngs:
return pngs[0].name
return ""
def _read_glb_json(glb_path: Path) -> dict | None:
"""Read the JSON chunk from a GLB (Binary glTF) file.
GLB structure: 12-byte header + chunks. Chunk 0 is JSON.
Returns parsed dict or None on failure.
"""
try:
with open(glb_path, "rb") as f:
header = f.read(12)
if len(header) < 12:
return None
magic, version, length = struct.unpack("<III", header)
if magic != 0x46546C67: # 'glTF'
return None
chunk_header = f.read(8)
if len(chunk_header) < 8:
return None
chunk_length, chunk_type = struct.unpack("<II", chunk_header)
if chunk_type != 0x4E4F534A: # 'JSON'
return None
json_bytes = f.read(chunk_length)
return json.loads(json_bytes)
except Exception as e:
logger.debug("Failed to read GLB JSON from %s: %s", glb_path, e)
return None
def _quat_to_matrix(q: list[float]) -> list[list[float]]:
"""Convert quaternion [x, y, z, w] to 3×3 rotation matrix."""
x, y, z, w = q
return [
[1 - 2*(y*y + z*z), 2*(x*y - z*w), 2*(x*z + y*w)],
[ 2*(x*y + z*w), 1 - 2*(x*x + z*z), 2*(y*z - x*w)],
[ 2*(x*z - y*w), 2*(y*z + x*w), 1 - 2*(x*x + y*y)],
]
def _get_glb_root_rotation(device_dir: Path) -> list[list[float]] | None:
"""Extract root node rotation matrix from the first GLB in device_dir/meshes/.
Only rotation is extracted — GLB scale is NOT applied because STL files
are already in meters while GLB scale converts GLB mesh units (often mm)
to scene units. Since we read STL directly, scale is irrelevant.
Returns 3×3 rotation matrix or None if no GLB or no rotation found.
"""
meshes_dir = device_dir / "meshes"
if not meshes_dir.exists():
return None
glbs = sorted(meshes_dir.glob("*.glb"))
if not glbs:
return None
gltf = _read_glb_json(glbs[0])
if gltf is None:
return None
nodes = gltf.get("nodes", [])
if not nodes:
return None
root = nodes[0]
rotation = root.get("rotation")
if rotation is None:
return None
# Skip identity quaternion [0,0,0,1]
x, y, z, w = rotation
if abs(x) < 1e-9 and abs(y) < 1e-9 and abs(z) < 1e-9 and abs(w - 1.0) < 1e-9:
return None
return _quat_to_matrix(rotation)
def _apply_rotation_to_bbox(
stl_min: list[float], stl_max: list[float],
rot: list[list[float]],
) -> tuple[list[float], list[float]]:
"""Apply rotation to an axis-aligned bounding box.
Transforms all 8 corners of the STL AABB through rotation,
then computes the new AABB in glTF space.
"""
corners = []
for x in (stl_min[0], stl_max[0]):
for y in (stl_min[1], stl_max[1]):
for z in (stl_min[2], stl_max[2]):
tx = rot[0][0]*x + rot[0][1]*y + rot[0][2]*z
ty = rot[1][0]*x + rot[1][1]*y + rot[1][2]*z
tz = rot[2][0]*x + rot[2][1]*y + rot[2][2]*z
corners.append((tx, ty, tz))
xs = [c[0] for c in corners]
ys = [c[1] for c in corners]
zs = [c[2] for c in corners]
return [min(xs), min(ys), min(zs)], [max(xs), max(ys), max(zs)]
def extract_one_device(device_dir: Path) -> dict | None:
"""提取单个设备的足迹信息。"""
try:
import trimesh
except ImportError:
logger.error("trimesh not installed. Run: pip install trimesh")
return None
mesh_files = _find_mesh_files(device_dir)
if not mesh_files:
return None
# 加载所有网格部件并计算联合包围盒
meshes = []
for f in mesh_files:
try:
m = trimesh.load(str(f), force="mesh")
if hasattr(m, "bounds") and m.bounds is not None:
meshes.append(m)
except Exception as e:
logger.warning("Failed to load %s: %s", f, e)
if not meshes:
return None
if len(meshes) == 1:
combined = meshes[0]
else:
combined = trimesh.util.concatenate(meshes)
bounds = combined.bounds
stl_min = [float(bounds[0][i]) for i in range(3)]
stl_max = [float(bounds[1][i]) for i in range(3)]
# 应用 GLB 根节点旋转到 STL 包围盒scale 不应用 — STL 已是米制)
# glTF 约定: X=right, Y=up, Z=forward → 2D 足迹取 X 和 Z, 高度取 Y
rot = _get_glb_root_rotation(device_dir)
if rot is not None:
t_min, t_max = _apply_rotation_to_bbox(stl_min, stl_max, rot)
t_size = [t_max[i] - t_min[i] for i in range(3)]
t_center = [(t_min[i] + t_max[i]) / 2 for i in range(3)]
# glTF Y-up: X=width, Z=depth, Y=height
bbox_w = round(t_size[0], 4)
bbox_d = round(t_size[2], 4)
height = round(t_size[1], 4)
origin_offset = [round(t_center[0], 4), round(t_center[2], 4)]
logger.debug(
"%s: GLB rotation applied → bbox=[%.3f, %.3f] height=%.3f",
device_dir.name, bbox_w, bbox_d, height,
)
else:
# 无 GLB 或 identity rotation → 沿用原始 STL 坐标 (X=width, Y=depth, Z=height)
size = [stl_max[i] - stl_min[i] for i in range(3)]
center = [(stl_min[i] + stl_max[i]) / 2 for i in range(3)]
bbox_w = round(size[0], 4)
bbox_d = round(size[1], 4)
height = round(size[2], 4)
origin_offset = [round(center[0], 4), round(center[1], 4)]
model_file, model_type = _find_best_model_file(device_dir)
thumbnail_file = _find_thumbnail(device_dir)
device_id = device_dir.name
# 确定 openings手动标注优先否则尝试从 XACRO 自动提取
# 注意XACRO socket 坐标是 STL 原生坐标系,这里传入变换后的 bbox
if device_id in MANUAL_OPENINGS:
openings = MANUAL_OPENINGS[device_id]
else:
xacro_path = device_dir / "modal.xacro"
if xacro_path.exists():
openings = extract_openings_from_xacro(
xacro_path,
bbox_center_xy=(origin_offset[0], origin_offset[1]),
bbox_size_xy=(bbox_w, bbox_d),
)
else:
openings = []
result: dict = {
"bbox": [bbox_w, bbox_d],
"height": height,
"origin_offset": origin_offset,
"model_file": model_file,
"model_type": model_type,
"thumbnail_file": thumbnail_file,
"openings": openings,
}
return result
def extract_all(
assets_dir: Path | None = None,
registry_dir: Path | None = None,
device_ids: list[str] | None = None,
) -> dict[str, dict]:
"""提取所有(或指定)设备的足迹。
Args:
assets_dir: uni-lab-assets/device_models/ 路径
registry_dir: Uni-Lab-OS/unilabos/device_mesh/devices/ 路径
device_ids: 仅提取指定设备None = 全部扫描)
Returns:
{device_id: footprint_dict}
"""
results: dict[str, dict] = {}
dirs_to_scan: list[tuple[Path, str]] = []
if assets_dir and assets_dir.exists():
for d in sorted(assets_dir.iterdir()):
if d.is_dir() and (device_ids is None or d.name in device_ids):
dirs_to_scan.append((d, "assets"))
if registry_dir and registry_dir.exists():
for d in sorted(registry_dir.iterdir()):
if d.is_dir() and (device_ids is None or d.name in device_ids):
if d.name not in results: # assets 已有的不重复扫描
dirs_to_scan.append((d, "registry"))
for device_dir, source in dirs_to_scan:
device_id = device_dir.name
if device_id in results:
continue
footprint = extract_one_device(device_dir)
if footprint:
footprint["source"] = source
results[device_id] = footprint
logger.info(
"Extracted %s: bbox=%s height=%.3f source=%s",
device_id,
footprint["bbox"],
footprint["height"],
source,
)
# 统计自动提取的 openings 数量
auto_xacro_count = sum(
1
for fp in results.values()
if any(o.get("label") == "auto_xacro" for o in fp.get("openings", []))
)
logger.info(
"Auto-extracted openings from XACRO for %d / %d devices",
auto_xacro_count,
len(results),
)
# 手动后备
for dev_id, (w, d, h) in FALLBACK_SIZES.items():
if dev_id not in results:
results[dev_id] = {
"bbox": [w, d],
"height": h,
"origin_offset": [0.0, 0.0],
"model_file": "",
"model_type": "",
"thumbnail_file": "",
"openings": MANUAL_OPENINGS.get(dev_id, []),
"source": "manual",
}
return results
def main() -> None:
parser = argparse.ArgumentParser(
description="Extract device footprints from STL/GLB meshes"
)
parser.add_argument(
"--assets-dir",
type=Path,
default=Path(__file__).resolve().parent.parent / "uni-lab-assets" / "device_models",
help="Path to uni-lab-assets/device_models/",
)
parser.add_argument(
"--registry-dir",
type=Path,
default=Path(__file__).resolve().parent / "Uni-Lab-OS" / "unilabos" / "device_mesh" / "devices",
help="Path to Uni-Lab-OS device_mesh/devices/",
)
parser.add_argument(
"--output",
type=Path,
default=Path(__file__).resolve().parent / "footprints.json",
help="Output JSON path",
)
parser.add_argument(
"--devices",
nargs="*",
default=None,
help="Only extract these device IDs (default: all)",
)
parser.add_argument("-v", "--verbose", action="store_true")
args = parser.parse_args()
logging.basicConfig(
level=logging.DEBUG if args.verbose else logging.INFO,
format="%(levelname)s: %(message)s",
)
logger.info("Assets dir: %s (exists=%s)", args.assets_dir, args.assets_dir.exists())
logger.info("Registry dir: %s (exists=%s)", args.registry_dir, args.registry_dir.exists())
results = extract_all(
assets_dir=args.assets_dir,
registry_dir=args.registry_dir,
device_ids=args.devices,
)
with open(args.output, "w") as f:
json.dump(results, f, indent=2, ensure_ascii=False)
logger.info("Wrote %d devices to %s", len(results), args.output)
if __name__ == "__main__":
main()

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,187 @@
"""
Generate a YAML registry file for all devices in uni-lab-assets that don't
already have a registry entry (identified by model.mesh value).
Output: Uni-Lab-OS/unilabos/registry/devices/asset_models.yaml
"""
import json
from pathlib import Path
import yaml
# ---------------------------------------------------------------------------
# Paths (resolved relative to this script's location)
# ---------------------------------------------------------------------------
REPO_ROOT = Path(__file__).parent.parent
ASSETS_DIR = REPO_ROOT.parent / "uni-lab-assets" / "device_models"
REGISTRY_DIR = REPO_ROOT / "Uni-Lab-OS" / "unilabos" / "registry" / "devices"
OUTPUT_FILE = REGISTRY_DIR / "asset_models.yaml"
OSS_BASE = (
"https://uni-lab.oss-cn-zhangjiakou.aliyuncs.com/uni-lab/devices"
)
CONTAINER_CLASS = (
"unilabos.devices.resource_container.container:HotelContainer"
)
# ---------------------------------------------------------------------------
# Step 1 — collect mesh names already present in the registry
# ---------------------------------------------------------------------------
def collect_registered_meshes() -> set[str]:
"""Return the set of mesh values found in all existing registry YAML files."""
registered: set[str] = set()
for yaml_file in REGISTRY_DIR.glob("*.yaml"):
# Skip the output file itself so the script is idempotent
if yaml_file == OUTPUT_FILE:
continue
try:
with yaml_file.open("r", encoding="utf-8") as fh:
data = yaml.safe_load(fh)
except Exception as exc:
print(f" [warn] Could not parse {yaml_file.name}: {exc}")
continue
if not isinstance(data, dict):
continue
for _key, entry in data.items():
if not isinstance(entry, dict):
continue
model = entry.get("model")
if isinstance(model, dict):
mesh = model.get("mesh")
if mesh:
registered.add(str(mesh))
return registered
# ---------------------------------------------------------------------------
# Step 2 — scan uni-lab-assets/device_models/
# ---------------------------------------------------------------------------
def scan_asset_devices() -> list[dict]:
"""
Return a list of device dicts for every subfolder that has a modal.xacro.
Each dict has keys: folder_name, description.
"""
devices = []
if not ASSETS_DIR.is_dir():
raise FileNotFoundError(f"Assets directory not found: {ASSETS_DIR}")
for device_dir in sorted(ASSETS_DIR.iterdir()):
if not device_dir.is_dir():
continue
folder_name = device_dir.name
# modal.xacro is required
if not (device_dir / "modal.xacro").exists():
continue
# Read optional meta.json
description = folder_name
meta_path = device_dir / "meta.json"
if meta_path.exists():
try:
with meta_path.open("r", encoding="utf-8") as fh:
meta = json.load(fh)
# Use name field if present; otherwise fall back to folder name
description = meta.get("name", folder_name)
except Exception as exc:
print(f" [warn] Could not parse {meta_path}: {exc}")
devices.append(
{
"folder_name": folder_name,
"description": description,
}
)
return devices
# ---------------------------------------------------------------------------
# Step 3 — build registry entry for a single device
# ---------------------------------------------------------------------------
def build_entry(folder_name: str, description: str) -> dict:
return {
"category": ["asset_model"],
"class": {
"action_value_mappings": {},
"module": CONTAINER_CLASS,
"status_types": {},
"type": "python",
},
"config_info": [],
"description": description,
"handles": [],
"icon": "",
"init_param_schema": {
"config": {
"properties": {},
"required": [],
"type": "object",
},
"data": {
"properties": {},
"required": [],
"type": "object",
},
},
"model": {
"mesh": folder_name,
"path": f"{OSS_BASE}/{folder_name}/macro_device.xacro",
"type": "device",
},
"version": "1.0.0",
}
# ---------------------------------------------------------------------------
# Main
# ---------------------------------------------------------------------------
def main() -> None:
print("Scanning existing registry for registered meshes...")
registered_meshes = collect_registered_meshes()
print(f" Found {len(registered_meshes)} already-registered mesh(es).")
print(f"\nScanning asset devices in: {ASSETS_DIR}")
all_devices = scan_asset_devices()
print(f" Found {len(all_devices)} device folder(s) with modal.xacro.")
registry: dict[str, dict] = {}
skipped = 0
generated = 0
for device in all_devices:
folder_name = device["folder_name"]
if folder_name in registered_meshes:
skipped += 1
continue
key = f"asset_model.{folder_name}"
registry[key] = build_entry(folder_name, device["description"])
generated += 1
print(f"\nWriting {generated} new entr(ies) to: {OUTPUT_FILE}")
OUTPUT_FILE.parent.mkdir(parents=True, exist_ok=True)
with OUTPUT_FILE.open("w", encoding="utf-8") as fh:
yaml.dump(
registry,
fh,
default_flow_style=False,
allow_unicode=True,
sort_keys=False,
)
print("\n--- Summary ---")
print(f" Total devices found (with modal.xacro): {len(all_devices)}")
print(f" Already registered (skipped): {skipped}")
print(f" Newly generated: {generated}")
if __name__ == "__main__":
main()

View File

@@ -0,0 +1,373 @@
"""意图解释器:将语义化意图翻译为 Constraint 列表。"""
from __future__ import annotations
import itertools
from collections.abc import Callable
from dataclasses import dataclass, field
from .constraints import PRIORITY_MULTIPLIERS
from .models import Constraint, Intent
# 优先级权重映射
_PRIORITY_WEIGHTS: dict[str, float] = {"low": 1.0, "medium": 3.0, "high": 8.0}
_DEFAULT_WEIGHT = _PRIORITY_WEIGHTS["medium"]
def _priority_key(priority: str) -> str:
"""将 intent priority 映射到 constraint 权重等级。"""
return "normal" if priority == "medium" else priority
def _final_weight(base_weight: float, priority: str) -> float:
"""在解释阶段直接烘焙优先级乘数。"""
return base_weight * PRIORITY_MULTIPLIERS.get(priority, 1.0)
@dataclass
class InterpretResult:
"""意图解释结果。"""
constraints: list[Constraint] = field(default_factory=list)
translations: list[dict] = field(default_factory=list)
errors: list[str] = field(default_factory=list)
workflow_edges: list[list[str]] = field(default_factory=list)
def _handle_reachable_by(intent: Intent, result: InterpretResult) -> None:
"""reachable_by机械臂必须能到达指定设备列表。"""
arm = intent.params.get("arm")
targets = intent.params.get("targets", [])
if arm is None:
result.errors.append(f"reachable_by: 缺少必要参数 'arm'")
return
if not targets:
result.errors.append(f"reachable_by: 参数 'targets' 不能为空")
return
generated: list[dict] = []
for target in targets:
c = Constraint(
type="hard",
rule_name="reachability",
params={"arm_id": arm, "target_device_id": target},
weight=_final_weight(1.0, "critical"),
)
result.constraints.append(c)
generated.append({"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight})
result.translations.append({
"source_intent": intent.intent,
"source_description": intent.description,
"source_params": intent.params,
"generated_constraints": generated,
"explanation": f"机械臂 '{arm}' 需要能够到达 {len(targets)} 个目标设备",
})
def _handle_close_together(intent: Intent, result: InterpretResult) -> None:
"""close_together设备组内两两最小化距离。"""
devices: list[str] = intent.params.get("devices", [])
priority: str = intent.params.get("priority", "medium")
if len(devices) < 2:
result.errors.append(f"close_together: 参数 'devices' 至少需要 2 个设备,当前 {len(devices)}")
return
weight = _final_weight(
_PRIORITY_WEIGHTS.get(priority, _DEFAULT_WEIGHT),
_priority_key(priority),
)
generated: list[dict] = []
for dev_a, dev_b in itertools.combinations(devices, 2):
c = Constraint(
type="soft",
rule_name="minimize_distance",
params={"device_a": dev_a, "device_b": dev_b},
weight=weight,
)
result.constraints.append(c)
generated.append({"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight})
result.translations.append({
"source_intent": intent.intent,
"source_description": intent.description,
"source_params": intent.params,
"generated_constraints": generated,
"explanation": f"设备组 {devices} 应尽量靠近(优先级: {priority}",
})
def _handle_far_apart(intent: Intent, result: InterpretResult) -> None:
"""far_apart设备组内两两最大化距离。"""
devices: list[str] = intent.params.get("devices", [])
priority: str = intent.params.get("priority", "medium")
if len(devices) < 2:
result.errors.append(f"far_apart: 参数 'devices' 至少需要 2 个设备,当前 {len(devices)}")
return
weight = _final_weight(
_PRIORITY_WEIGHTS.get(priority, _DEFAULT_WEIGHT),
_priority_key(priority),
)
generated: list[dict] = []
for dev_a, dev_b in itertools.combinations(devices, 2):
c = Constraint(
type="soft",
rule_name="maximize_distance",
params={"device_a": dev_a, "device_b": dev_b},
weight=weight,
)
result.constraints.append(c)
generated.append({"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight})
result.translations.append({
"source_intent": intent.intent,
"source_description": intent.description,
"source_params": intent.params,
"generated_constraints": generated,
"explanation": f"设备组 {devices} 应尽量分散(优先级: {priority}",
})
def _handle_max_distance(intent: Intent, result: InterpretResult) -> None:
"""max_distance两设备间距不超过指定值。"""
device_a = intent.params.get("device_a")
device_b = intent.params.get("device_b")
distance = intent.params.get("distance")
if device_a is None or device_b is None or distance is None:
result.errors.append(
f"max_distance: 缺少必要参数,需要 'device_a''device_b''distance'"
f"当前: device_a={device_a}, device_b={device_b}, distance={distance}"
)
return
c = Constraint(
type="hard",
rule_name="distance_less_than",
params={"device_a": device_a, "device_b": device_b, "distance": distance},
weight=_final_weight(1.0, "normal"),
)
result.constraints.append(c)
result.translations.append({
"source_intent": intent.intent,
"source_description": intent.description,
"source_params": intent.params,
"generated_constraints": [{"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight}],
"explanation": f"设备 '{device_a}''{device_b}' 之间的距离不得超过 {distance}",
})
def _handle_min_distance(intent: Intent, result: InterpretResult) -> None:
"""min_distance两设备间距不小于指定值。"""
device_a = intent.params.get("device_a")
device_b = intent.params.get("device_b")
distance = intent.params.get("distance")
if device_a is None or device_b is None or distance is None:
result.errors.append(
f"min_distance: 缺少必要参数,需要 'device_a''device_b''distance'"
f"当前: device_a={device_a}, device_b={device_b}, distance={distance}"
)
return
c = Constraint(
type="hard",
rule_name="distance_greater_than",
params={"device_a": device_a, "device_b": device_b, "distance": distance},
weight=_final_weight(1.0, "normal"),
)
result.constraints.append(c)
result.translations.append({
"source_intent": intent.intent,
"source_description": intent.description,
"source_params": intent.params,
"generated_constraints": [{"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight}],
"explanation": f"设备 '{device_a}''{device_b}' 之间的距离不得小于 {distance}",
})
def _handle_min_spacing(intent: Intent, result: InterpretResult) -> None:
"""min_spacing所有设备之间的最小间隙。"""
min_gap: float = intent.params.get("min_gap", 0.3)
c = Constraint(
type="hard",
rule_name="min_spacing",
params={"min_gap": min_gap},
weight=_final_weight(1.0, "high"),
)
result.constraints.append(c)
result.translations.append({
"source_intent": intent.intent,
"source_description": intent.description,
"source_params": intent.params,
"generated_constraints": [{"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight}],
"explanation": f"所有设备之间至少保持 {min_gap} 米的间隙",
})
def _handle_face_outward(intent: Intent, result: InterpretResult) -> None:
"""face_outward设备朝向偏好为向外。"""
c = Constraint(
type="soft",
rule_name="prefer_orientation_mode",
params={"mode": "outward"},
weight=_final_weight(1.0, "low"),
)
result.constraints.append(c)
result.translations.append({
"source_intent": intent.intent,
"source_description": intent.description,
"source_params": intent.params,
"generated_constraints": [{"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight}],
"explanation": "设备开口偏好朝向实验室外侧",
})
def _handle_face_inward(intent: Intent, result: InterpretResult) -> None:
"""face_inward设备朝向偏好为向内。"""
c = Constraint(
type="soft",
rule_name="prefer_orientation_mode",
params={"mode": "inward"},
weight=_final_weight(1.0, "low"),
)
result.constraints.append(c)
result.translations.append({
"source_intent": intent.intent,
"source_description": intent.description,
"source_params": intent.params,
"generated_constraints": [{"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight}],
"explanation": "设备开口偏好朝向实验室内侧",
})
def _handle_align_cardinal(intent: Intent, result: InterpretResult) -> None:
"""align_cardinal设备偏好对齐到主轴方向。"""
c = Constraint(
type="soft",
rule_name="prefer_aligned",
params={},
weight=_final_weight(1.0, "low"),
)
result.constraints.append(c)
result.translations.append({
"source_intent": intent.intent,
"source_description": intent.description,
"source_params": intent.params,
"generated_constraints": [{"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight}],
"explanation": "设备偏好与实验室主轴对齐0°/90°/180°/270°",
})
def _handle_keep_adjacent(intent: Intent, result: InterpretResult) -> None:
"""keep_adjacent两个设备保持相邻同 close_together 逻辑,支持 priority 映射)。"""
devices: list[str] = intent.params.get("devices", [])
priority: str = intent.params.get("priority", "medium")
if len(devices) < 2:
result.errors.append(f"keep_adjacent: 参数 'devices' 至少需要 2 个设备,当前 {len(devices)}")
return
weight = _final_weight(
_PRIORITY_WEIGHTS.get(priority, _DEFAULT_WEIGHT),
_priority_key(priority),
)
generated: list[dict] = []
for dev_a, dev_b in itertools.combinations(devices, 2):
c = Constraint(
type="soft",
rule_name="minimize_distance",
params={"device_a": dev_a, "device_b": dev_b},
weight=weight,
)
result.constraints.append(c)
generated.append({"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight})
result.translations.append({
"source_intent": intent.intent,
"source_description": intent.description,
"source_params": intent.params,
"generated_constraints": generated,
"explanation": f"设备组 {devices} 应保持相邻(优先级: {priority}",
})
def _handle_workflow_hint(intent: Intent, result: InterpretResult) -> None:
"""workflow_hint工作流顺序暗示相邻步骤设备靠近。"""
workflow: str = intent.params.get("workflow", "")
devices: list[str] = intent.params.get("devices", [])
if len(devices) < 2:
result.errors.append(
f"workflow_hint: 参数 'devices' 至少需要 2 个设备,当前 {len(devices)}"
)
return
generated: list[dict] = []
for dev_a, dev_b in zip(devices[:-1], devices[1:]):
c = Constraint(
type="soft",
rule_name="minimize_distance",
params={"device_a": dev_a, "device_b": dev_b},
weight=_final_weight(1.0, "normal"),
)
result.constraints.append(c)
generated.append({"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight})
result.workflow_edges.append([dev_a, dev_b])
result.translations.append({
"source_intent": intent.intent,
"source_description": intent.description,
"source_params": intent.params,
"generated_constraints": generated,
"explanation": f"工作流 '{workflow}' 中相邻步骤设备应靠近",
"confidence": "low",
})
# 意图处理器分发表
_HANDLERS: dict[str, Callable[[Intent, InterpretResult], None]] = {
"reachable_by": _handle_reachable_by,
"close_together": _handle_close_together,
"far_apart": _handle_far_apart,
"max_distance": _handle_max_distance,
"min_distance": _handle_min_distance,
"min_spacing": _handle_min_spacing,
"face_outward": _handle_face_outward,
"face_inward": _handle_face_inward,
"align_cardinal": _handle_align_cardinal,
"keep_adjacent": _handle_keep_adjacent,
"workflow_hint": _handle_workflow_hint,
}
def interpret_intents(intents: list[Intent]) -> InterpretResult:
"""将意图列表翻译为约束列表。
Args:
intents: 语义化意图列表(通常由 LLM 生成)
Returns:
InterpretResult包含约束、翻译记录、错误信息和工作流边
"""
result = InterpretResult()
for intent in intents:
handler = _HANDLERS.get(intent.intent)
if handler is None:
result.errors.append(f"未知意图类型: '{intent.intent}',跳过处理")
continue
handler(intent, result)
return result

View File

@@ -0,0 +1,41 @@
"""Protocol 接口定义,隔离 ROS 依赖。
开发阶段使用 mock_checkers.py 中的 Mock 实现,
集成阶段替换为 ros_checkers.py 中的 MoveIt2 / IKFast 实现。
"""
from __future__ import annotations
from typing import Protocol
class CollisionChecker(Protocol):
"""碰撞检测接口。"""
def check(self, placements: list[dict]) -> list[tuple[str, str]]:
"""返回碰撞设备对列表。
Args:
placements: [{"id": str, "bbox": (w, d), "pos": (x, y, θ)}, ...]
Returns:
[("device_a", "device_b"), ...] 存在碰撞的设备对
"""
...
class ReachabilityChecker(Protocol):
"""可达性检测接口。"""
def is_reachable(self, arm_id: str, arm_pose: dict, target: dict) -> bool:
"""判断机械臂在给定位姿下能否到达目标点。
Args:
arm_id: 机械臂设备 ID
arm_pose: {"x": float, "y": float, "theta": float}
target: {"x": float, "y": float, "z": float}
Returns:
True 如果可达
"""
...

View File

@@ -0,0 +1,49 @@
"""解析实验室平面图 JSON。
简单格式:
{
"width": 6.0,
"depth": 4.0,
"obstacles": [
{"x": 2.0, "y": 0.0, "width": 0.1, "depth": 1.0}
]
}
"""
from __future__ import annotations
import json
from pathlib import Path
from .models import Lab, Obstacle
def parse_lab(data: dict) -> Lab:
"""从字典解析实验室平面图。"""
obstacles = []
for obs in data.get("obstacles", []):
obstacles.append(
Obstacle(
x=float(obs["x"]),
y=float(obs["y"]),
width=float(obs["width"]),
depth=float(obs["depth"]),
)
)
return Lab(
width=float(data["width"]),
depth=float(data["depth"]),
obstacles=obstacles,
)
def load_lab_from_file(path: str | Path) -> Lab:
"""从 JSON 文件加载实验室平面图。"""
with open(path) as f:
data = json.load(f)
return parse_lab(data)
def create_simple_lab(width: float, depth: float) -> Lab:
"""创建一个无障碍物的简单矩形实验室。"""
return Lab(width=width, depth=depth)

View File

@@ -0,0 +1,187 @@
# Demo Agent — Lab Layout Orchestrator
You are a lab layout agent for a recorded demo. Your job is to take a natural language lab request, translate it into optimizer constraints, run the optimization, and push results to the 3D frontend — all while outputting only concise, readable status lines.
## CRITICAL OUTPUT RULES
- Output ONLY short status lines. No markdown fences. No raw JSON. No explanations.
- Every HTTP call uses `curl -s` (silent). Never show curl output to the user.
- Parse responses internally. Extract only the fields needed for your status lines.
- Server base URL: `http://localhost:8000`
## Pipeline
Execute these steps in order. Print the status line shown after each step.
### Step 1 — Retrieve devices
Run:
```
curl -s http://localhost:8000/devices
```
Filter to `is_standalone: true` entries. Count them. Build an id→name lookup.
Print:
```
retrieving devices... N standalone devices found
```
Then print an id mapping table showing the user-friendly name → device_id for devices relevant to the user's request:
```
id mapping:
plate hotel → thermo_orbitor_rs2_hotel
robot arm → arm_slider
liquid handler → opentrons_liquid_handler
plate sealer → agilent_plateloc
pcr machine → inheco_odtc_96xl
```
Only include devices that are relevant to the user's request, not the full catalog.
### Step 2 — Translate intent to constraints
Using the rules in `layout_intent_translator.md` (which you have already read), translate the user's natural language request into an intents JSON structure.
Do NOT print the JSON. Instead, print a human-readable constraint summary:
```
translating intent to constraints...
constraints:
hard: arm_slider must reach 4 devices
hard: min spacing 0.05m between all devices
soft: workflow order hotel → liquid handler → sealer → pcr
soft: all devices close together (high priority)
soft: align to cardinal directions
```
### Step 3 — Interpret intents
Send the intents JSON to the interpret endpoint:
```
curl -s -X POST http://localhost:8000/interpret \
-H "Content-Type: application/json" \
-d '{ "intents": [...] }'
```
Capture the `constraints` and `workflow_edges` arrays from the response. Do NOT print anything for this step — it's a silent validation.
If `errors` is non-empty, print:
```
warning: N intents failed to translate
```
### Step 3.5 — Read lab dimensions
```
curl -s http://localhost:8000/scene/lab
```
Returns `{"width": W, "depth": D}`. Use these values for the optimize request. Do NOT print anything for this step.
### Step 4 — Optimize layout
Build the optimize request using:
- `devices`: the relevant devices from Step 1 (id, name, device_type)
- `lab`: the `{"width": W, "depth": D}` from Step 3.5
- `constraints`: from Step 3 interpret response
- `workflow_edges`: from Step 3 interpret response
- `seeder`: `"compact_outward"` (default)
- `seeder_overrides`: generally not needed. Cardinal alignment is handled by the `align_cardinal` intent (generates `prefer_aligned` constraint). Do NOT use `align_weight` in seeder_overrides — it is deprecated.
- `snap_cardinal`: `false` (default). Set `true` only if user explicitly requests snapping to 0/90/180/270.
- `run_de`: `true`
- `maxiter`: `200`
- `seed`: `42`
Run:
```
curl -s -X POST http://localhost:8000/optimize \
-H "Content-Type: application/json" \
-d '{ ... }'
```
Print:
```
optimizing layout (DE, 200 iterations)...
optimization complete — cost: X.XX, success: true/false
```
If `success` is false, print:
```
error: optimization failed (cost: inf) — constraints may conflict
```
And stop.
### Step 5 — Apply placements
Take the `placements` array from the optimize response and POST them. Do NOT add a `location` field — the backend schema only accepts `device_id`, `uuid`, `position`, and `rotation`. Extra fields will cause validation errors.
```
curl -s -X POST http://localhost:8000/scene/placements \
-H "Content-Type: application/json" \
-d '{ "placements": [
{
"device_id": "...",
"uuid": "...",
"position": {"x": ..., "y": ..., "z": ...},
"rotation": {"x": ..., "y": ..., "z": ...}
}
] }'
```
**Important — version-based polling:** The frontend polls `GET /scene/placements` every 1 second and uses a version number to detect changes. On the **first poll**, it captures the current version as a baseline and does **not** apply placements. It only renders placements when the version **increases beyond** that baseline. This means if you POST placements before the frontend has polled once, the frontend will silently skip that update.
**Solution:** After the initial POST, send the **same request a second time** to bump the version. This guarantees the frontend sees a version increase after its baseline poll and applies the placements.
Print:
```
applying placements to scene...
layout applied — N devices positioned
```
## Follow-up Requests
If the user gives a follow-up request (e.g., "now move the sealer farther from the thermal cycler"):
1. Print a `---` separator
2. Keep the same device list (no need to re-fetch)
3. Translate the NEW request into intents — these REPLACE the previous constraints entirely
4. Run Steps 35 again with the new constraints
5. Same output format
## Error Handling
- Server unreachable: `error: server unreachable at localhost:8000`
- Optimize fails: `error: optimization failed (cost: inf) — constraints may conflict`
- After any error, stop and wait for user input.
## Device Name Resolution
You have `layout_intent_translator.md` loaded as context. Use its device name resolution rules to match user's informal names (e.g., "PCR machine", "the arm", "liquid handler") to exact device IDs from the catalog retrieved in Step 1.
## Example Full Output
For input: "Set up a PCR workflow — hotel, liquid handler, sealer, thermal cycler. The arm handles all transfers. Keep it compact."
```
retrieving devices... 47 standalone devices found
id mapping:
plate hotel → thermo_orbitor_rs2_hotel
robot arm → arm_slider
liquid handler → opentrons_liquid_handler
plate sealer → agilent_plateloc
pcr machine → inheco_odtc_96xl
translating intent to constraints...
constraints:
hard: arm_slider must reach 4 devices
soft: workflow order hotel → liquid handler → sealer → pcr
soft: all devices close together (high priority)
soft: align to cardinal directions
optimizing layout (DE, 200 iterations)...
optimization complete — cost: 0.00, success: true
applying placements to scene...
layout applied — 5 devices positioned
```

View File

@@ -0,0 +1,312 @@
# Layout Intent Translator — LLM Skill
You are a lab layout intent translator. Your job is to convert natural language descriptions of lab layout requirements into structured JSON intents that the layout optimizer can understand.
## Your Role
Users describe their lab needs in natural language. You must:
1. Identify devices by their IDs from the provided device list
2. Infer spatial relationships, workflow order, and physical constraints
3. Output structured intents (JSON) that map to the optimizer's intent schema
4. Provide clear `description` fields so users can verify the translation
## Output Format
You MUST output a JSON object with an `intents` array. Each intent has:
```json
{
"intents": [
{
"intent": "<intent_type>",
"params": { ... },
"description": "Human-readable explanation of what this intent means"
}
]
}
```
## Available Intent Types
### `reachable_by` — Robot arm must reach devices
```json
{
"intent": "reachable_by",
"params": {
"arm": "arm_device_id",
"targets": ["device_a", "device_b"]
},
"description": "Robot arm must be able to reach device A and device B"
}
```
**When to use:** Any time a robot arm transfers items between devices, all those devices must be reachable.
### `close_together` — Devices should be near each other
```json
{
"intent": "close_together",
"params": {
"devices": ["device_a", "device_b", "device_c"],
"priority": "high"
},
"description": "These devices are used frequently together and should be close"
}
```
**Priority:** `"low"` (nice-to-have), `"medium"` (default), `"high"` (critical for workflow speed)
Priority is only part of the intent input. The interpreter automatically bakes it into the emitted constraint `weight`; there is no separate constraint-level `priority` field in `/interpret` output or `/optimize` input.
### `far_apart` — Devices should be separated
```json
{
"intent": "far_apart",
"params": {
"devices": ["heat_source", "reagent_storage"],
"priority": "medium"
}
}
```
**When to use:** Thermal interference, contamination risk, safety separation.
### `keep_adjacent` — Devices should stay adjacent
```json
{
"intent": "keep_adjacent",
"params": {
"devices": ["device_a", "device_b"],
"priority": "high"
}
}
```
**When to use:** User explicitly asks for a pair or group to stay side-by-side / adjacent. This currently maps to the same optimizer behavior as `close_together`, but is semantically more precise.
### `max_distance` — Hard limit on maximum distance
```json
{
"intent": "max_distance",
"params": {
"device_a": "device_a_id",
"device_b": "device_b_id",
"distance": 1.5
}
}
```
**When to use:** Physical constraints like tube length, cable reach, arm range.
### `min_distance` — Hard limit on minimum distance
```json
{
"intent": "min_distance",
"params": {
"device_a": "device_a_id",
"device_b": "device_b_id",
"distance": 0.5
}
}
```
**When to use:** Safety clearance, thermal isolation, vibration separation.
### `min_spacing` — Global minimum gap between all devices
```json
{
"intent": "min_spacing",
"params": { "min_gap": 0.3 }
}
```
**When to use:** General accessibility, maintenance clearance.
### `workflow_hint` — Workflow step ordering
```json
{
"intent": "workflow_hint",
"params": {
"workflow": "pcr",
"devices": ["liquid_handler", "thermal_cycler", "plate_sealer", "storage"]
}
}
```
**When to use:** When user describes a sequential process. Devices are listed in workflow order. Consecutive devices will be placed near each other.
### `face_outward` / `face_inward` / `align_cardinal`
```json
{"intent": "face_outward"}
{"intent": "face_inward"}
{"intent": "align_cardinal"}
```
**When to use:** User mentions accessibility from outside, central robot, or neat alignment.
## Device Name Resolution
You will receive the current scene's device list as context. This is the **only** source of valid device IDs. Users will refer to devices using informal names — you must match them to exact IDs from this list.
### Input Context Format
Before each translation request, you receive the scene's device list:
```
Devices in scene:
- thermo_orbitor_rs2_hotel: Thermo Orbitor RS2 Hotel (type: static, bbox: 0.68×0.52m)
- arm_slider: Arm Slider (type: articulation, bbox: 1.20×0.30m)
- opentrons_liquid_handler: Opentrons Liquid Handler (type: static, bbox: 0.65×0.60m)
- agilent_plateloc: Agilent PlateLoc (type: static, bbox: 0.35×0.40m)
- inheco_odtc_96xl: Inheco ODTC 96XL (type: static, bbox: 0.30×0.35m)
```
### Matching Rules
1. **Exact match first**: If user says "arm_slider", match directly
2. **Name/brand match**: "opentrons" → `opentrons_liquid_handler`, "plateloc" → `agilent_plateloc`
3. **Function match**: "PCR machine" / "thermal cycler" → `inheco_odtc_96xl`; "liquid handler" / "pipetting robot" → `opentrons_liquid_handler`; "plate hotel" / "storage" → `thermo_orbitor_rs2_hotel`; "plate sealer" → `agilent_plateloc`
4. **Type match**: "robot arm" / "the arm" → look for `device_type: articulation`
5. **Ambiguous**: If multiple devices could match, list candidates in the `description` field and pick the most likely one. If truly ambiguous, return an error intent asking the user to clarify.
### Duplicate Device Convention
When the same catalog device appears multiple times in the scene:
- first instance keeps the bare catalog ID, e.g. `plate_reader`
- second and later instances use `#N`, e.g. `plate_reader#2`, `plate_reader#3`
- a bare ID in an intent fans out to all instances
- a suffixed ID applies only to that specific instance
Examples:
- `{"devices": ["plate_reader", "storage_hotel"]}` applies to every `plate_reader` instance
- `{"devices": ["plate_reader#2", "storage_hotel"]}` applies only to the second instance
### Example Resolution
User says: "the robot should reach the PCR machine and the liquid handler"
Scene devices: `arm_slider` (articulation), `inheco_odtc_96xl`, `opentrons_liquid_handler`, ...
Resolution:
- "the robot" → `arm_slider` (only articulation-type device)
- "PCR machine" → `inheco_odtc_96xl` (thermal cycler = PCR)
- "liquid handler" → `opentrons_liquid_handler`
## Translation Rules
### 1. Robot Arm Inference
If any robot arm is in the device list and the workflow involves plate/sample transfer between devices, ALL devices that exchange plates/samples with each other via the arm must be in `reachable_by.targets`.
### 2. Workflow Order
When a user describes a process (e.g., "prepare samples, then run PCR, then seal"), extract the device order and create a `workflow_hint`. The device order follows the sample processing path.
### 3. Implicit Constraints
- If devices frequently exchange items → `close_together` (high priority)
- If user explicitly says "keep these adjacent", "side by side", or "next to each other" → `keep_adjacent`
- If a robot arm is mentioned "in between" → `reachable_by` for all involved devices
- If user says "short transit" or "fast transfer" → `close_together` with `"priority": "high"`
- If user says "keep X away from Y" → `far_apart` or `min_distance`
### 4. Don't Over-Constrain
- Only add constraints the user's description implies
- When unsure about priority, use `"medium"`
- For workflow_hint, confidence is inherently `"low"` — the optimizer notes this
## Example: PCR Workflow
**User input:**
> "Take plate from hotel, prepare sample in opentrons, seal plate then pcr cycle, arm_slider handles all transfers"
**Device list provided:**
- `thermo_orbitor_rs2_hotel` (plate hotel/storage)
- `arm_slider` (robot arm on linear rail)
- `opentrons_liquid_handler` (liquid handling/pipetting)
- `agilent_plateloc` (plate sealer)
- `inheco_odtc_96xl` (thermal cycler for PCR)
**Your output:**
```json
{
"intents": [
{
"intent": "reachable_by",
"params": {
"arm": "arm_slider",
"targets": [
"thermo_orbitor_rs2_hotel",
"opentrons_liquid_handler",
"agilent_plateloc",
"inheco_odtc_96xl"
]
},
"description": "arm_slider must reach all devices since it handles all plate transfers"
},
{
"intent": "workflow_hint",
"params": {
"workflow": "pcr",
"devices": [
"thermo_orbitor_rs2_hotel",
"opentrons_liquid_handler",
"agilent_plateloc",
"inheco_odtc_96xl"
]
},
"description": "PCR workflow order: hotel → liquid handler → plate sealer → thermal cycler"
},
{
"intent": "close_together",
"params": {
"devices": ["opentrons_liquid_handler", "agilent_plateloc"],
"priority": "high"
},
"description": "Sealing happens immediately after sample prep — minimize transit time"
}
]
}
```
**Reasoning:**
- The arm handles ALL transfers → all 4 devices in reachable_by targets
- User described a clear sequence → workflow_hint in that order
- "seal plate then pcr" implies sealing is immediately after prep → close_together for the pair with high priority
## Example: Simple Proximity Request
**User input:**
> "Keep the thermal cycler close to the plate sealer, at most 1 meter apart"
**Your output:**
```json
{
"intents": [
{
"intent": "max_distance",
"params": {
"device_a": "inheco_odtc_96xl",
"device_b": "agilent_plateloc",
"distance": 1.0
},
"description": "Thermal cycler and plate sealer must be within 1 meter"
}
]
}
```
## API Integration
### Discovery
Call `GET /interpret/schema` to get the current list of available intent types and their parameter specifications. Always check this before translating, as new intent types may be added.
### Translation
Send your output to `POST /interpret`:
```
POST /interpret
Content-Type: application/json
{
"intents": [ ... your translated intents ... ]
}
```
### Response
The endpoint returns:
- `constraints` — ready to pass to `/optimize`
- `translations` — human-readable mapping of each intent to generated constraints
- `workflow_edges` — extracted workflow connections
- `errors` — any intents that failed to translate
### Optimization
After user confirms the translation, pass `constraints` and `workflow_edges` to `POST /optimize` along with the device list and lab dimensions.

View File

@@ -0,0 +1,110 @@
"""Mock 检测器:无 ROS 依赖的简化碰撞与可达性检测。
碰撞检测基于 OBB SATO(n²) 两两比较)。
可达性检测基于最大臂展半径的欧几里得距离判断。
集成阶段由 ros_checkers.py 中的 MoveItCollisionChecker / IKFastReachabilityChecker 替代。
"""
from __future__ import annotations
import math
from .obb import obb_corners, obb_overlap
class MockCollisionChecker:
"""基于 OBB SAT 的碰撞检测。
输入格式与 CollisionChecker Protocol 一致:
placements: [{"id": str, "bbox": (w, d), "pos": (x, y, θ)}, ...]
"""
def check(self, placements: list[dict]) -> list[tuple[str, str]]:
"""返回所有碰撞的设备对。"""
collisions: list[tuple[str, str]] = []
n = len(placements)
for i in range(n):
for j in range(i + 1, n):
a, b = placements[i], placements[j]
corners_a = obb_corners(
a["pos"][0], a["pos"][1],
a["bbox"][0], a["bbox"][1],
a["pos"][2] if len(a["pos"]) > 2 else 0.0,
)
corners_b = obb_corners(
b["pos"][0], b["pos"][1],
b["bbox"][0], b["bbox"][1],
b["pos"][2] if len(b["pos"]) > 2 else 0.0,
)
if obb_overlap(corners_a, corners_b):
collisions.append((a["id"], b["id"]))
return collisions
def check_bounds(
self, placements: list[dict], lab_width: float, lab_depth: float
) -> list[str]:
"""返回超出实验室边界的设备 ID 列表。"""
out_of_bounds: list[str] = []
for p in placements:
hw, hd = self._rotated_half_extents(p)
x, y = p["pos"][:2]
if x - hw < 0 or x + hw > lab_width or y - hd < 0 or y + hd > lab_depth:
out_of_bounds.append(p["id"])
return out_of_bounds
@staticmethod
def _rotated_half_extents(p: dict) -> tuple[float, float]:
"""计算旋转后 AABB 的半宽和半深。"""
w, d = p["bbox"]
theta = p["pos"][2] if len(p["pos"]) > 2 else 0.0
cos_t = abs(math.cos(theta))
sin_t = abs(math.sin(theta))
half_w = (w * cos_t + d * sin_t) / 2
half_d = (w * sin_t + d * cos_t) / 2
return half_w, half_d
class MockReachabilityChecker:
"""基于最大臂展半径的简化可达性判断。
内置常见 Elite CS 系列机械臂的臂展参数。
自定义臂展可通过构造参数传入。
"""
# 默认臂展参数(单位:米)
DEFAULT_ARM_REACH: dict[str, float] = {
"elite_cs63": 0.624,
"elite_cs66": 0.914,
"elite_cs612": 1.304,
"elite_cs620": 1.800,
"arm_slider": 0.3, # 线性导轨臂1.07 body 2.14m × 0.35mreach ≈ half length
}
# 未知型号回退臂展realistic default for lab-scale arms
DEFAULT_FALLBACK_REACH: float = 0.4
def __init__(self, arm_reach: dict[str, float] | None = None):
self.arm_reach = {**self.DEFAULT_ARM_REACH, **(arm_reach or {})}
def is_reachable(self, arm_id: str, arm_pose: dict, target: dict) -> bool:
"""判断目标点是否在机械臂最大臂展半径内。
Uses OBB edge-to-edge distance when available (passed as _obb_dist),
otherwise falls back to center-to-center Euclidean distance.
Args:
arm_id: 机械臂型号 ID用于查臂展
arm_pose: {"x": float, "y": float, "theta": float}
target: {"x": float, "y": float, "z": float, "_obb_dist": float (optional)}
Returns:
True 如果目标在臂展半径内
"""
max_reach = self.arm_reach.get(arm_id, self.DEFAULT_FALLBACK_REACH)
if "_obb_dist" in target:
return target["_obb_dist"] <= max_reach
dx = target["x"] - arm_pose["x"]
dy = target["y"] - arm_pose["y"]
dist_sq = dx**2 + dy**2
return dist_sq <= max_reach**2

View File

@@ -0,0 +1,96 @@
"""数据模型定义Device, Lab, Placement, Constraint 及 API 请求/响应。"""
from __future__ import annotations
import math
from dataclasses import dataclass, field
from typing import Literal
@dataclass
class Opening:
"""设备的访问开口(用于方向约束)。"""
# 设备局部坐标系中的方向单位向量,如 (0, -1) = 正前方
direction: tuple[float, float] = (0.0, -1.0)
label: str = ""
@dataclass
class Device:
"""设备描述。"""
id: str
name: str
# 碰撞包围盒 (width along X, depth along Y),单位:米
bbox: tuple[float, float] = (0.6, 0.4)
device_type: Literal["static", "articulation", "rigid"] = "static"
# 以下为可选扩展字段(向后兼容)
height: float = 0.4
origin_offset: tuple[float, float] = (0.0, 0.0)
openings: list[Opening] = field(default_factory=list)
source: Literal["registry", "assets", "manual"] = "manual"
model_path: str = ""
model_type: str = ""
thumbnail_url: str = ""
uuid: str = ""
@dataclass
class Obstacle:
"""实验室内固定障碍物(矩形)。"""
x: float
y: float
width: float
depth: float
@dataclass
class Lab:
"""实验室平面图。"""
width: float # X 方向,单位:米
depth: float # Y 方向,单位:米
obstacles: list[Obstacle] = field(default_factory=list)
@dataclass
class Placement:
"""单个设备的布局位姿。"""
device_id: str
x: float
y: float
theta: float # 旋转角,弧度
uuid: str = "" # 前端分配的唯一标识,透传不生成
def rotated_bbox(self, device: Device) -> tuple[float, float]:
"""返回旋转后的 AABB 尺寸 (half_w, half_h)。"""
w, d = device.bbox
cos_t = abs(math.cos(self.theta))
sin_t = abs(math.sin(self.theta))
half_w = (w * cos_t + d * sin_t) / 2
half_h = (w * sin_t + d * cos_t) / 2
return half_w, half_h
@dataclass
class Constraint:
"""约束规则。"""
type: Literal["hard", "soft"]
rule_name: str
# 规则参数,含义因 rule_name 而异
params: dict = field(default_factory=dict)
# 仅 soft 约束使用
weight: float = 1.0
@dataclass
class Intent:
"""LLM 可生成的语义化意图,由 interpreter 翻译为 Constraint 列表。"""
intent: str # 意图类型,如 "reachable_by", "close_together"
params: dict = field(default_factory=dict)
description: str = "" # 可选的自然语言描述(用于审计/调试)

View File

@@ -0,0 +1,257 @@
"""OBB (Oriented Bounding Box) geometry: corners, overlap (SAT), minimum distance."""
from __future__ import annotations
import math
def obb_corners(
cx: float, cy: float, w: float, h: float, theta: float
) -> list[tuple[float, float]]:
"""Return 4 corners of the OBB as (x, y) tuples.
Args:
cx, cy: center position
w, h: full width and height (not half-extents)
theta: rotation angle in radians
"""
hw, hh = w / 2, h / 2
cos_t, sin_t = math.cos(theta), math.sin(theta)
dx_w, dy_w = hw * cos_t, hw * sin_t # half-width vector
dx_h, dy_h = -hh * sin_t, hh * cos_t # half-height vector
return [
(cx + dx_w + dx_h, cy + dy_w + dy_h),
(cx - dx_w + dx_h, cy - dy_w + dy_h),
(cx - dx_w - dx_h, cy - dy_w - dy_h),
(cx + dx_w - dx_h, cy + dy_w - dy_h),
]
def _get_axes(corners: list[tuple[float, float]]) -> list[tuple[float, float]]:
"""Return 2 edge-normal axes for a rectangle (4 corners)."""
axes = []
for i in range(2): # Only need 2 axes for a rectangle
edge_x = corners[i + 1][0] - corners[i][0]
edge_y = corners[i + 1][1] - corners[i][1]
length = math.sqrt(edge_x**2 + edge_y**2)
if length > 0:
axes.append((-edge_y / length, edge_x / length))
return axes
def _project(corners: list[tuple[float, float]], axis: tuple[float, float]) -> tuple[float, float]:
"""Project all corners onto axis, return (min, max) scalar projections."""
dots = [c[0] * axis[0] + c[1] * axis[1] for c in corners]
return min(dots), max(dots)
def obb_overlap(corners_a: list[tuple[float, float]], corners_b: list[tuple[float, float]]) -> bool:
"""Return True if two OBBs overlap using Separating Axis Theorem.
Uses strict inequality (touching edges = no overlap).
"""
for axis in _get_axes(corners_a) + _get_axes(corners_b):
min_a, max_a = _project(corners_a, axis)
min_b, max_b = _project(corners_b, axis)
if max_a <= min_b or max_b <= min_a:
return False
return True
def _point_to_segment_dist_sq(
px: float, py: float,
ax: float, ay: float,
bx: float, by: float,
) -> float:
"""Squared distance from point (px,py) to line segment (ax,ay)-(bx,by)."""
dx, dy = bx - ax, by - ay
len_sq = dx * dx + dy * dy
if len_sq == 0:
return (px - ax) ** 2 + (py - ay) ** 2
t = max(0.0, min(1.0, ((px - ax) * dx + (py - ay) * dy) / len_sq))
proj_x, proj_y = ax + t * dx, ay + t * dy
return (px - proj_x) ** 2 + (py - proj_y) ** 2
def obb_penetration_depth(
corners_a: list[tuple[float, float]],
corners_b: list[tuple[float, float]],
) -> float:
"""Minimum penetration depth between two OBBs (SAT-based).
Returns 0.0 if not overlapping. Otherwise returns the minimum overlap
along any separating axis — the smallest push needed to separate them.
"""
min_overlap = float("inf")
for axis in _get_axes(corners_a) + _get_axes(corners_b):
min_a, max_a = _project(corners_a, axis)
min_b, max_b = _project(corners_b, axis)
overlap = min(max_a - min_b, max_b - min_a)
if overlap <= 0:
return 0.0 # Separated on this axis
if overlap < min_overlap:
min_overlap = overlap
return min_overlap
def nearest_point_on_obb(
px: float, py: float,
corners: list[tuple[float, float]],
) -> tuple[float, float]:
"""Return the nearest point on an OBB's boundary to point (px, py).
If the point is inside the OBB, returns the nearest edge point.
"""
best_x, best_y = corners[0]
best_dist_sq = float("inf")
n = len(corners)
for i in range(n):
ax, ay = corners[i]
bx, by = corners[(i + 1) % n]
dx, dy = bx - ax, by - ay
len_sq = dx * dx + dy * dy
if len_sq == 0:
proj_x, proj_y = ax, ay
else:
t = max(0.0, min(1.0, ((px - ax) * dx + (py - ay) * dy) / len_sq))
proj_x, proj_y = ax + t * dx, ay + t * dy
d_sq = (px - proj_x) ** 2 + (py - proj_y) ** 2
if d_sq < best_dist_sq:
best_dist_sq = d_sq
best_x, best_y = proj_x, proj_y
return best_x, best_y
def segment_intersects_obb(
p1: tuple[float, float],
p2: tuple[float, float],
corners: list[tuple[float, float]],
) -> bool:
"""Return True if line segment p1-p2 intersects the OBB (convex polygon).
Uses separating axis theorem on the Minkowski difference:
test segment against each edge of the polygon + segment normal.
"""
# Quick: test each edge of the OBB against the segment
n = len(corners)
for i in range(n):
ax, ay = corners[i]
bx, by = corners[(i + 1) % n]
if _segments_intersect(p1[0], p1[1], p2[0], p2[1], ax, ay, bx, by):
return True
# Also check if segment is fully inside the OBB
if _point_in_convex(p1, corners) or _point_in_convex(p2, corners):
return True
return False
def _segments_intersect(
ax: float, ay: float, bx: float, by: float,
cx: float, cy: float, dx: float, dy: float,
) -> bool:
"""Return True if segment AB intersects segment CD (proper or endpoint)."""
def cross(ox: float, oy: float, px: float, py: float, qx: float, qy: float) -> float:
return (px - ox) * (qy - oy) - (py - oy) * (qx - ox)
d1 = cross(cx, cy, dx, dy, ax, ay)
d2 = cross(cx, cy, dx, dy, bx, by)
d3 = cross(ax, ay, bx, by, cx, cy)
d4 = cross(ax, ay, bx, by, dx, dy)
if ((d1 > 0 and d2 < 0) or (d1 < 0 and d2 > 0)) and \
((d3 > 0 and d4 < 0) or (d3 < 0 and d4 > 0)):
return True
# Collinear cases — skip for simplicity (near-zero probability in DE)
return False
def _point_in_convex(
p: tuple[float, float], corners: list[tuple[float, float]]
) -> bool:
"""Return True if point is inside a convex polygon (corners in order)."""
n = len(corners)
sign = None
for i in range(n):
ax, ay = corners[i]
bx, by = corners[(i + 1) % n]
cross = (bx - ax) * (p[1] - ay) - (by - ay) * (p[0] - ax)
if abs(cross) < 1e-12:
continue
s = cross > 0
if sign is None:
sign = s
elif s != sign:
return False
return True
def segment_obb_intersection_length(
p1: tuple[float, float],
p2: tuple[float, float],
corners: list[tuple[float, float]],
) -> float:
"""线段 p1-p2 与 OBB凸多边形的交集长度。
Cyrus-Beck 线段裁剪算法。corners 假定为 CCW 顺序obb_corners 生成)。
无交集返回 0.0。
"""
dx = p2[0] - p1[0]
dy = p2[1] - p1[1]
seg_len_sq = dx * dx + dy * dy
if seg_len_sq < 1e-24:
return 0.0
t_enter = 0.0
t_exit = 1.0
n = len(corners)
for i in range(n):
ax, ay = corners[i]
bx, by = corners[(i + 1) % n]
# CCW 多边形边的外法线: (ey, -ex), e = b - a
ex, ey = bx - ax, by - ay
nx, ny = ey, -ex
denom = nx * dx + ny * dy
numer = nx * (p1[0] - ax) + ny * (p1[1] - ay)
if abs(denom) < 1e-12:
if numer > 0:
return 0.0 # 在此边外侧且平行
continue
t = -numer / denom
if denom < 0:
t_enter = max(t_enter, t) # 进入
else:
t_exit = min(t_exit, t) # 退出
if t_enter > t_exit:
return 0.0
if t_enter >= t_exit:
return 0.0
return (t_exit - t_enter) * math.sqrt(seg_len_sq)
def obb_min_distance(
corners_a: list[tuple[float, float]],
corners_b: list[tuple[float, float]],
) -> float:
"""Minimum distance between two OBBs (convex polygons).
Returns 0.0 if overlapping or touching.
"""
if obb_overlap(corners_a, corners_b):
return 0.0
min_dist_sq = float("inf")
for poly, other in [(corners_a, corners_b), (corners_b, corners_a)]:
n = len(other)
for px, py in poly:
for i in range(n):
ax, ay = other[i]
bx, by = other[(i + 1) % n]
d_sq = _point_to_segment_dist_sq(px, py, ax, ay, bx, by)
if d_sq < min_dist_sq:
min_dist_sq = d_sq
return math.sqrt(min_dist_sq)

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,144 @@
"""初始布局生成Pencil MCP 接口 + 行列式回退。
策略:
1. 尝试调用 Pencil AI MCP 生成初始布局
2. 若 Pencil 不可用或失败,回退到行列式放置算法
行列式回退逻辑:
- 设备按面积从大到小排序
- 沿 X 轴逐个放置,行满(超出 lab.width则换行
- 设备间保留 margin 间距
- 所有设备 θ=0朝向不变
"""
from __future__ import annotations
import logging
from .models import Device, Lab, Placement
logger = logging.getLogger(__name__)
# 设备间最小间距(米)
DEFAULT_MARGIN = 0.3
def generate_initial_layout(
devices: list[Device],
lab: Lab,
margin: float = DEFAULT_MARGIN,
) -> list[Placement]:
"""生成初始布局方案。
优先尝试 Pencil MCP失败则回退到行列式放置。
Args:
devices: 待放置的设备列表
lab: 实验室平面图
margin: 设备间最小间距
Returns:
初始布局 Placement 列表
"""
# 尝试 Pencil MCP
pencil_result = _try_pencil(devices, lab)
if pencil_result is not None:
logger.info("Using Pencil AI generated layout")
return pencil_result
# 回退到行列式
logger.info("Pencil unavailable, using row-based fallback layout")
return generate_fallback(devices, lab, margin)
def _try_pencil(
devices: list[Device],
lab: Lab,
) -> list[Placement] | None:
"""尝试通过 Pencil AI MCP 生成布局。
当前 Pencil MCP 不可用,返回 None 触发回退。
未来集成时,此函数应:
1. 将设备 2D 投影 + 实验室平面图序列化为 Pencil 输入格式
2. 调用 mcp__pencil_* 工具
3. 解析返回的布局方案为 Placement 列表
预留接口参数:
- devices: 设备列表id, bbox
- lab: 实验室尺寸
"""
# TODO: 当 Pencil MCP 可用时实现
# 预期调用方式:
# pencil_input = {
# "floor_plan": {"width": lab.width, "depth": lab.depth},
# "items": [{"id": d.id, "width": d.bbox[0], "depth": d.bbox[1]} for d in devices],
# }
# result = mcp__pencil_layout(pencil_input)
# return [Placement(device_id=r["id"], x=r["x"], y=r["y"], theta=r["theta"]) for r in result]
return None
def generate_fallback(
devices: list[Device],
lab: Lab,
margin: float = DEFAULT_MARGIN,
) -> list[Placement]:
"""行列式回退布局:按面积从大到小排序,逐行放置。
放置规则:
- 设备中心坐标,从左上角开始
- 每行从 margin + half_width 开始
- 行满(下一个设备右边缘超出 lab.width - margin则换行
- 行高取该行最大设备深度
Args:
devices: 待放置的设备列表
lab: 实验室平面图
margin: 设备间最小间距
Returns:
Placement 列表。若实验室空间不足,剩余设备堆叠在右下角并记录警告。
"""
if not devices:
return []
# 按面积从大到小排序
sorted_devices = sorted(devices, key=lambda d: d.bbox[0] * d.bbox[1], reverse=True)
placements: list[Placement] = []
cursor_x = margin
cursor_y = margin
row_height = 0.0
for dev in sorted_devices:
w, d = dev.bbox
half_w = w / 2
half_d = d / 2
# 检查当前行是否放得下
if cursor_x + half_w + margin > lab.width and placements:
# 换行
cursor_x = margin
cursor_y += row_height + margin
row_height = 0.0
# 设备中心位置
cx = cursor_x + half_w
cy = cursor_y + half_d
# 检查是否超出实验室深度
if cy + half_d + margin > lab.depth:
logger.warning(
"Lab space insufficient for device '%s' (%s), "
"placing at overflow position",
dev.id,
dev.bbox,
)
placements.append(Placement(device_id=dev.id, x=cx, y=cy, theta=0.0))
# 更新游标
cursor_x = cx + half_w + margin
row_height = max(row_height, d)
return placements

View File

@@ -0,0 +1,29 @@
[build-system]
requires = ["setuptools>=68.0", "wheel"]
build-backend = "setuptools.build_meta"
[project]
name = "layout-optimizer"
version = "0.1.0"
description = "AI laboratory layout optimizer for Uni-Lab Phase 3"
requires-python = ">=3.10"
dependencies = [
"scipy>=1.10",
"numpy>=1.24",
"fastapi>=0.100",
"uvicorn>=0.20",
"pydantic>=2.0",
]
[project.optional-dependencies]
dev = [
"pytest>=7.0",
"httpx>=0.24",
]
[tool.setuptools.packages.find]
where = ["."]
include = ["layout_optimizer*"]
[tool.pytest.ini_options]
testpaths = ["tests"]

View File

@@ -0,0 +1,433 @@
"""ROS2/MoveIt2 碰撞检测与 IKFast 可达性检测适配器。
集成阶段替换 mock_checkers.py 中的 Mock 实现,
依赖 Uni-Lab-OS 的 moveit2.py 提供的 MoveIt2 Python 接口。
用法:
from .ros_checkers import MoveItCollisionChecker, IKFastReachabilityChecker
# 碰撞检测
checker = MoveItCollisionChecker(moveit2_instance)
collisions = checker.check(placements)
# 可达性检测(体素图 O(1) 查询 + 实时 IK 回退)
reachability = IKFastReachabilityChecker(moveit2_instance, voxel_dir="/path/to/voxels")
reachable = reachability.is_reachable("elite_cs66", arm_pose, target)
环境变量:
LAYOUT_CHECKER_MODE: "mock" | "moveit" — 选择检测器实现(默认 "mock"
LAYOUT_VOXEL_DIR: 预计算体素图目录路径(.npz 文件)
前置条件:
- ROS2 + MoveIt2 运行中
- moveit2.py 中的 MoveIt2 实例已初始化
- 命名规范:碰撞对象使用 {device_id}_ 前缀
"""
from __future__ import annotations
import logging
import math
import os
from pathlib import Path
from typing import TYPE_CHECKING, Any
import numpy as np
from .obb import obb_corners, obb_overlap
if TYPE_CHECKING:
pass
logger = logging.getLogger(__name__)
# ---------- 坐标变换辅助 ----------
def _yaw_to_quat(theta: float) -> tuple[float, float, float, float]:
"""将 2D 旋转角(绕 Z 轴弧度)转换为四元数 (x, y, z, w)。"""
return (0.0, 0.0, math.sin(theta / 2), math.cos(theta / 2))
def _transform_to_arm_frame(
arm_pose: dict, target: dict,
) -> tuple[float, float, float]:
"""将目标点从世界坐标系变换到机械臂基坐标系。
Args:
arm_pose: {"x": float, "y": float, "theta": float}
target: {"x": float, "y": float, "z": float}
Returns:
(local_x, local_y, local_z) 在臂基坐标系中的位置
"""
dx = target["x"] - arm_pose["x"]
dy = target["y"] - arm_pose["y"]
theta = arm_pose.get("theta", 0.0)
cos_t = math.cos(-theta)
sin_t = math.sin(-theta)
local_x = dx * cos_t - dy * sin_t
local_y = dx * sin_t + dy * cos_t
local_z = target.get("z", 0.0)
return (local_x, local_y, local_z)
# ---------- MoveItCollisionChecker ----------
class MoveItCollisionChecker:
"""通过 MoveIt2 PlanningScene 进行碰撞检测。
工作流程:
1. 将所有设备同步为 MoveIt2 碰撞盒({device_id}_ 前缀)
2. 使用 python-fcl 进行精确两两碰撞检测(若可用)
3. 若 FCL 不可用,回退到 OBB SAT 检测
同步到 MoveIt2 确保机器人运动规划也能感知设备布局。
"""
def __init__(
self,
moveit2: Any,
*,
default_height: float = 0.4,
sync_to_scene: bool = True,
):
"""
Args:
moveit2: Uni-Lab-OS moveit2.py 中的 MoveIt2 实例
default_height: 碰撞盒默认高度(米)
sync_to_scene: 是否同步碰撞对象到 MoveIt2 规划场景
"""
self._moveit2 = moveit2
self._default_height = default_height
self._sync_to_scene = sync_to_scene
self._fcl_available = self._check_fcl()
@staticmethod
def _check_fcl() -> bool:
"""检查 python-fcl 是否可用。"""
try:
import fcl # noqa: F401
return True
except ImportError:
return False
def check(self, placements: list[dict]) -> list[tuple[str, str]]:
"""返回碰撞设备对列表。
Args:
placements: [{"id": str, "bbox": (w, d), "pos": (x, y, θ)}, ...]
Returns:
[("device_a", "device_b"), ...] 存在碰撞的设备对
"""
# 同步到 MoveIt2 规划场景
if self._sync_to_scene:
self._sync_collision_objects(placements)
# 碰撞检测
if self._fcl_available:
return self._check_with_fcl(placements)
return self._check_with_obb(placements)
def check_bounds(
self, placements: list[dict], lab_width: float, lab_depth: float,
) -> list[str]:
"""返回超出实验室边界的设备 ID 列表。"""
out_of_bounds: list[str] = []
for p in placements:
hw, hd = self._rotated_half_extents(p)
x, y = p["pos"][:2]
if x - hw < 0 or x + hw > lab_width or y - hd < 0 or y + hd > lab_depth:
out_of_bounds.append(p["id"])
return out_of_bounds
def _sync_collision_objects(self, placements: list[dict]) -> None:
"""将设备布局同步到 MoveIt2 规划场景。
使用 {device_id}_ 前缀命名碰撞对象。
"""
for p in placements:
obj_id = f"{p['id']}_"
w, d = p["bbox"]
x, y = p["pos"][:2]
theta = p["pos"][2] if len(p["pos"]) > 2 else 0.0
h = self._default_height
try:
self._moveit2.add_collision_box(
id=obj_id,
size=(w, d, h),
position=(x, y, h / 2),
quat_xyzw=_yaw_to_quat(theta),
)
except Exception:
logger.warning("Failed to sync collision object %s", obj_id, exc_info=True)
def _check_with_fcl(self, placements: list[dict]) -> list[tuple[str, str]]:
"""使用 python-fcl 进行精确碰撞检测。"""
import fcl
objects: list[tuple[str, Any]] = []
for p in placements:
w, d = p["bbox"]
h = self._default_height
x, y = p["pos"][:2]
theta = p["pos"][2] if len(p["pos"]) > 2 else 0.0
geom = fcl.Box(w, d, h)
tf = fcl.Transform(
_yaw_to_rotation_matrix(theta),
np.array([x, y, h / 2]),
)
obj = fcl.CollisionObject(geom, tf)
objects.append((p["id"], obj))
collisions: list[tuple[str, str]] = []
n = len(objects)
for i in range(n):
for j in range(i + 1, n):
id_a, obj_a = objects[i]
id_b, obj_b = objects[j]
request = fcl.CollisionRequest()
result = fcl.CollisionResult()
ret = fcl.collide(obj_a, obj_b, request, result)
if ret > 0:
collisions.append((id_a, id_b))
return collisions
def _check_with_obb(self, placements: list[dict]) -> list[tuple[str, str]]:
"""OBB SAT 回退检测(与 MockCollisionChecker 相同算法)。"""
collisions: list[tuple[str, str]] = []
n = len(placements)
for i in range(n):
for j in range(i + 1, n):
a, b = placements[i], placements[j]
corners_a = obb_corners(
a["pos"][0], a["pos"][1],
a["bbox"][0], a["bbox"][1],
a["pos"][2] if len(a["pos"]) > 2 else 0.0,
)
corners_b = obb_corners(
b["pos"][0], b["pos"][1],
b["bbox"][0], b["bbox"][1],
b["pos"][2] if len(b["pos"]) > 2 else 0.0,
)
if obb_overlap(corners_a, corners_b):
collisions.append((a["id"], b["id"]))
return collisions
@staticmethod
def _rotated_half_extents(p: dict) -> tuple[float, float]:
"""计算旋转后 AABB 的半宽和半深。"""
w, d = p["bbox"]
theta = p["pos"][2] if len(p["pos"]) > 2 else 0.0
cos_t = abs(math.cos(theta))
sin_t = abs(math.sin(theta))
half_w = (w * cos_t + d * sin_t) / 2
half_d = (w * sin_t + d * cos_t) / 2
return half_w, half_d
# ---------- IKFastReachabilityChecker ----------
class IKFastReachabilityChecker:
"""基于 MoveIt2 compute_ik 和预计算体素图的可达性检测。
双模式:
1. 体素图模式O(1)):从 .npz 文件加载预计算可达性网格,
将目标点变换到臂基坐标系后直接查表。
2. 实时 IK 模式(~5ms/call调用 MoveIt2.compute_ik()
支持约束感知的精确可达性判断。
优先使用体素图,无匹配时回退到实时 IK。
"""
def __init__(
self,
moveit2: Any = None,
*,
voxel_dir: str | Path | None = None,
voxel_resolution: float = 0.01,
):
"""
Args:
moveit2: MoveIt2 实例(用于实时 IK 回退)
voxel_dir: 预计算体素图目录(.npz 文件,文件名 = arm_id
voxel_resolution: 体素分辨率(米),用于坐标 → 索引转换
"""
self._moveit2 = moveit2
self._voxel_resolution = voxel_resolution
self._voxel_maps: dict[str, _VoxelMap] = {}
if voxel_dir is not None:
self._load_voxel_maps(Path(voxel_dir))
def is_reachable(self, arm_id: str, arm_pose: dict, target: dict) -> bool:
"""判断机械臂在给定位姿下能否到达目标点。
Args:
arm_id: 机械臂设备 ID
arm_pose: {"x": float, "y": float, "theta": float}
target: {"x": float, "y": float, "z": float}
Returns:
True 如果可达
"""
local = _transform_to_arm_frame(arm_pose, target)
# 1. 体素图查询O(1)
if arm_id in self._voxel_maps:
return self._check_voxel(arm_id, local)
# 2. 实时 IK 回退
if self._moveit2 is not None:
return self._check_live_ik(local)
# 无可用检测方式,乐观返回(记录警告)
logger.warning(
"No reachability checker available for arm %s, returning True", arm_id,
)
return True
def _load_voxel_maps(self, voxel_dir: Path) -> None:
"""加载目录下所有 .npz 体素图文件。
文件格式:{arm_id}.npz包含
- "grid": bool ndarray (nx, ny, nz) — True 表示可达
- "origin": float ndarray (3,) — 网格原点(臂基坐标系)
- "resolution": float — 体素分辨率(米)
"""
if not voxel_dir.exists():
logger.warning("Voxel directory does not exist: %s", voxel_dir)
return
for npz_file in voxel_dir.glob("*.npz"):
arm_id = npz_file.stem
try:
data = np.load(str(npz_file))
grid = data["grid"].astype(bool)
origin = data["origin"].astype(float)
resolution = float(data.get("resolution", self._voxel_resolution))
self._voxel_maps[arm_id] = _VoxelMap(
grid=grid, origin=origin, resolution=resolution,
)
logger.info(
"Loaded voxel map for %s: shape=%s, resolution=%.3f",
arm_id, grid.shape, resolution,
)
except Exception:
logger.warning("Failed to load voxel map %s", npz_file, exc_info=True)
def _check_voxel(self, arm_id: str, local: tuple[float, float, float]) -> bool:
"""通过体素网格查询可达性。"""
vm = self._voxel_maps[arm_id]
ix = int(round((local[0] - vm.origin[0]) / vm.resolution))
iy = int(round((local[1] - vm.origin[1]) / vm.resolution))
iz = int(round((local[2] - vm.origin[2]) / vm.resolution))
if (
0 <= ix < vm.grid.shape[0]
and 0 <= iy < vm.grid.shape[1]
and 0 <= iz < vm.grid.shape[2]
):
return bool(vm.grid[ix, iy, iz])
# 超出体素图范围 → 不可达
return False
def _check_live_ik(self, local: tuple[float, float, float]) -> bool:
"""调用 MoveIt2.compute_ik() 进行实时可达性检测。
compute_ik 返回 JointState成功或 None不可达
使用默认朝下姿态(四元数 0, 1, 0, 0 即绕 X 轴旋转 180°
"""
# 目标姿态:末端执行器朝下
quat_xyzw = (0.0, 1.0, 0.0, 0.0)
try:
result = self._moveit2.compute_ik(
position=local,
quat_xyzw=quat_xyzw,
)
return result is not None
except Exception:
logger.warning("compute_ik call failed", exc_info=True)
return False
# ---------- 体素图数据类 ----------
class _VoxelMap:
"""预计算可达性体素网格。"""
__slots__ = ("grid", "origin", "resolution")
def __init__(
self,
grid: np.ndarray,
origin: np.ndarray,
resolution: float,
):
self.grid = grid
self.origin = origin
self.resolution = resolution
# ---------- FCL 辅助 ----------
def _yaw_to_rotation_matrix(theta: float) -> np.ndarray:
"""绕 Z 轴旋转矩阵3×3"""
c, s = math.cos(theta), math.sin(theta)
return np.array([
[c, -s, 0.0],
[s, c, 0.0],
[0.0, 0.0, 1.0],
])
# ---------- 工厂函数 ----------
def create_checkers(
moveit2: Any = None,
*,
mode: str | None = None,
voxel_dir: str | None = None,
) -> tuple[Any, Any]:
"""根据环境变量或参数创建检测器实例。
Args:
moveit2: MoveIt2 实例moveit 模式必需)
mode: "mock" | "moveit"(默认从 LAYOUT_CHECKER_MODE 环境变量读取)
voxel_dir: 体素图目录(默认从 LAYOUT_VOXEL_DIR 环境变量读取)
Returns:
(collision_checker, reachability_checker)
"""
if mode is None:
mode = os.getenv("LAYOUT_CHECKER_MODE", "mock")
if mode == "moveit":
if moveit2 is None:
raise ValueError("MoveIt2 instance required for 'moveit' checker mode")
if voxel_dir is None:
voxel_dir = os.getenv("LAYOUT_VOXEL_DIR")
collision = MoveItCollisionChecker(moveit2)
reachability = IKFastReachabilityChecker(
moveit2, voxel_dir=voxel_dir,
)
logger.info("Using MoveIt2 checkers (voxel_dir=%s)", voxel_dir)
return collision, reachability
# 默认mock 模式
from .mock_checkers import MockCollisionChecker, MockReachabilityChecker
logger.info("Using mock checkers")
return MockCollisionChecker(), MockReachabilityChecker()

View File

@@ -0,0 +1,331 @@
"""Force-directed seeder engine with named parameter presets.
Produces initial device placements for the layout optimizer.
Different layout strategies (compact, spread, workflow-aware) are
parameter configurations of the same force-directed simulation engine.
"""
from __future__ import annotations
import logging
import math
from dataclasses import dataclass, replace
from .models import Device, Lab, Placement
from .obb import obb_corners, obb_overlap, obb_min_distance
logger = logging.getLogger(__name__)
@dataclass
class SeederParams:
"""Parameters for the force-directed seeder engine."""
boundary_attraction: float = 0.0 # >0 push to walls, <0 push to center
mutual_repulsion: float = 1.0 # inter-device repulsion strength
edge_attraction: float = 0.0 # workflow edge attraction (Stage 2)
orientation_mode: str = "none" # "outward" | "inward" | "none"
PRESETS: dict[str, SeederParams | None] = {
"compact_outward": SeederParams(
boundary_attraction=-1.0, mutual_repulsion=0.5, orientation_mode="outward",
),
"spread_inward": SeederParams(
boundary_attraction=1.0, mutual_repulsion=1.0, orientation_mode="inward",
),
"workflow_cluster": SeederParams(
boundary_attraction=-0.5, mutual_repulsion=0.5,
edge_attraction=1.0, orientation_mode="outward",
),
"row_fallback": None, # Delegates to generate_fallback()
}
def resolve_seeder_params(
preset_name: str, overrides: dict | None = None,
) -> SeederParams | None:
"""Look up preset by name and apply overrides."""
if preset_name not in PRESETS:
raise ValueError(
f"Unknown seeder preset '{preset_name}'. "
f"Available: {list(PRESETS.keys())}"
)
params = PRESETS[preset_name]
if params is None or not overrides:
return params
return replace(params, **{k: v for k, v in overrides.items() if hasattr(params, k)})
def seed_layout(
devices: list[Device],
lab: Lab,
params: SeederParams | None,
edges: list[list[str]] | None = None,
) -> list[Placement]:
"""Generate initial device placements using force-directed simulation.
Args:
devices: devices to place
lab: lab dimensions
params: seeder parameters (None = row_fallback)
edges: workflow edges as [device_a_id, device_b_id] pairs (Stage 2)
Returns:
list of Placement objects, one per device
"""
if not devices:
return []
if params is None:
from .pencil_integration import generate_fallback
return generate_fallback(devices, lab)
return _force_simulation(devices, lab, params, edges)
def _force_simulation(
devices: list[Device],
lab: Lab,
params: SeederParams,
edges: list[list[str]] | None = None,
max_iter: int = 80,
dt: float = 0.05,
damping: float = 0.8,
) -> list[Placement]:
"""Run force-directed simulation to produce initial placements."""
n = len(devices)
center_x, center_y = lab.width / 2, lab.depth / 2
# Initialize positions: grid layout within lab bounds
cols = max(1, int(math.ceil(math.sqrt(n))))
rows_count = max(1, math.ceil(n / cols))
positions = [] # (x, y) per device
for i, dev in enumerate(devices):
row, col = divmod(i, cols)
margin = 0.3
x = margin + (col + 0.5) * (lab.width - 2 * margin) / cols
y = margin + (row + 0.5) * (lab.depth - 2 * margin) / rows_count
x = min(max(x, dev.bbox[0] / 2), lab.width - dev.bbox[0] / 2)
y = min(max(y, dev.bbox[1] / 2), lab.depth - dev.bbox[1] / 2)
positions.append([x, y])
# Initialize orientations
thetas = [0.0] * n
# Build edge lookup for Stage 2
edge_set: set[tuple[int, int]] = set()
if edges and params.edge_attraction > 0:
id_to_idx = {d.id: i for i, d in enumerate(devices)}
for e in edges:
if len(e) == 2 and e[0] in id_to_idx and e[1] in id_to_idx:
edge_set.add((id_to_idx[e[0]], id_to_idx[e[1]]))
converged = False
for iteration in range(max_iter):
forces = [[0.0, 0.0] for _ in range(n)]
total_force = 0.0
# 1. Boundary force
for i in range(n):
dx = positions[i][0] - center_x
dy = positions[i][1] - center_y
dist_to_center = math.sqrt(dx * dx + dy * dy) + 1e-9
f = params.boundary_attraction
forces[i][0] += f * dx / dist_to_center
forces[i][1] += f * dy / dist_to_center
# 2. Mutual repulsion (OBB edge-to-edge)
for i in range(n):
for j in range(i + 1, n):
ci = obb_corners(
positions[i][0], positions[i][1],
devices[i].bbox[0], devices[i].bbox[1], thetas[i],
)
cj = obb_corners(
positions[j][0], positions[j][1],
devices[j].bbox[0], devices[j].bbox[1], thetas[j],
)
dist = obb_min_distance(ci, cj)
if dist < 1e-9:
dist = 0.01 # Prevent division by zero for overlapping
dx = positions[i][0] - positions[j][0]
dy = positions[i][1] - positions[j][1]
d_center = math.sqrt(dx * dx + dy * dy) + 1e-9
repulsion = params.mutual_repulsion / (dist * dist + 0.1)
fx = repulsion * dx / d_center
fy = repulsion * dy / d_center
forces[i][0] += fx
forces[i][1] += fy
forces[j][0] -= fx
forces[j][1] -= fy
# 3. Edge attraction (Stage 2)
if params.edge_attraction > 0:
for i_idx, j_idx in edge_set:
dx = positions[j_idx][0] - positions[i_idx][0]
dy = positions[j_idx][1] - positions[i_idx][1]
dist = math.sqrt(dx * dx + dy * dy) + 1e-9
f = params.edge_attraction * dist * 0.1
forces[i_idx][0] += f * dx / dist
forces[i_idx][1] += f * dy / dist
forces[j_idx][0] -= f * dx / dist
forces[j_idx][1] -= f * dy / dist
# 4. Update positions (Euler + damping)
for i in range(n):
positions[i][0] += forces[i][0] * dt * damping
positions[i][1] += forces[i][1] * dt * damping
total_force += math.sqrt(forces[i][0]**2 + forces[i][1]**2)
# 5. Update orientations
if params.orientation_mode != "none":
for i in range(n):
thetas[i] = _compute_orientation(
positions[i][0], positions[i][1],
center_x, center_y,
devices[i], params.orientation_mode,
)
# 6. Clamp to lab bounds
for i in range(n):
hw, hh = devices[i].bbox[0] / 2, devices[i].bbox[1] / 2
positions[i][0] = max(hw, min(lab.width - hw, positions[i][0]))
positions[i][1] = max(hh, min(lab.depth - hh, positions[i][1]))
if total_force < 0.01 * n:
converged = True
logger.info("Force simulation converged at iteration %d", iteration)
break
if not converged:
logger.info("Force simulation reached max iterations (%d)", max_iter)
placements = [
Placement(device_id=devices[i].id, x=positions[i][0], y=positions[i][1], theta=thetas[i])
for i in range(n)
]
# Log initial collision count
initial_collisions = _count_collisions(devices, placements)
logger.info("Seeder: %d initial collision pairs before resolution", initial_collisions)
# Collision resolution pass
placements = _resolve_collisions(devices, placements, lab, max_passes=5)
# Log diagnostics
final_collisions = _count_collisions(devices, placements)
no_openings = sum(1 for d in devices if not d.openings)
logger.info(
"Seeder complete: %d devices, %d without openings, %d collision pairs remaining",
n, no_openings, final_collisions,
)
return placements
def _compute_orientation(
x: float, y: float,
center_x: float, center_y: float,
device: Device,
mode: str,
) -> float:
"""Compute theta so the device's front faces outward or inward."""
dx = x - center_x
dy = y - center_y
if abs(dx) < 1e-9 and abs(dy) < 1e-9:
return 0.0
angle_to_device = math.atan2(dy, dx)
if device.openings:
front = device.openings[0].direction
else:
front = (0.0, -1.0) # Default: -Y is front
front_angle = math.atan2(front[1], front[0])
if mode == "outward":
target = angle_to_device
elif mode == "inward":
target = angle_to_device + math.pi
else:
return 0.0
return (target - front_angle) % (2 * math.pi)
def _count_collisions(devices: list[Device], placements: list[Placement]) -> int:
"""Count OBB collision pairs (for diagnostics logging)."""
n = len(devices)
count = 0
for i in range(n):
for j in range(i + 1, n):
ci = obb_corners(placements[i].x, placements[i].y,
devices[i].bbox[0], devices[i].bbox[1], placements[i].theta)
cj = obb_corners(placements[j].x, placements[j].y,
devices[j].bbox[0], devices[j].bbox[1], placements[j].theta)
if obb_overlap(ci, cj):
count += 1
return count
def _resolve_collisions(
devices: list[Device],
placements: list[Placement],
lab: Lab,
max_passes: int = 5,
) -> list[Placement]:
"""Push overlapping devices apart. Returns new placement list."""
positions = [[p.x, p.y] for p in placements]
thetas = [p.theta for p in placements]
n = len(devices)
for pass_num in range(max_passes):
has_collision = False
for i in range(n):
for j in range(i + 1, n):
ci = obb_corners(
positions[i][0], positions[i][1],
devices[i].bbox[0], devices[i].bbox[1], thetas[i],
)
cj = obb_corners(
positions[j][0], positions[j][1],
devices[j].bbox[0], devices[j].bbox[1], thetas[j],
)
if obb_overlap(ci, cj):
has_collision = True
dx = positions[i][0] - positions[j][0]
dy = positions[i][1] - positions[j][1]
dist = math.sqrt(dx * dx + dy * dy) + 1e-9
push = 0.5 * (
max(devices[i].bbox[0], devices[i].bbox[1])
+ max(devices[j].bbox[0], devices[j].bbox[1])
) / 4
positions[i][0] += push * dx / dist
positions[i][1] += push * dy / dist
positions[j][0] -= push * dx / dist
positions[j][1] -= push * dy / dist
# Clamp to bounds (rotation-aware AABB half-extents)
for i in range(n):
cos_t = abs(math.cos(thetas[i]))
sin_t = abs(math.sin(thetas[i]))
hw = (devices[i].bbox[0] * cos_t + devices[i].bbox[1] * sin_t) / 2
hh = (devices[i].bbox[0] * sin_t + devices[i].bbox[1] * cos_t) / 2
positions[i][0] = max(hw, min(lab.width - hw, positions[i][0]))
positions[i][1] = max(hh, min(lab.depth - hh, positions[i][1]))
if not has_collision:
logger.info("Collision resolution complete after %d passes", pass_num + 1)
break
else:
logger.warning(
"Collision resolution: %d passes exhausted, collisions may remain",
max_passes,
)
return [
Placement(device_id=placements[i].device_id,
x=positions[i][0], y=positions[i][1],
theta=thetas[i], uuid=placements[i].uuid)
for i in range(n)
]

View File

@@ -0,0 +1,742 @@
"""FastAPI 开发服务器。
开发阶段独立运行于 localhost:8000前端通过 CORS 调用。
集成阶段合并到 Uni-Lab-OS 的 FastAPI 服务中。
运行方式:
uvicorn unilabos.layout_optimizer.server:app --host 0.0.0.0 --port 8000 --reload
调试模式(启用 DEBUG 日志,含优化器逐代 cost 明细):
LAYOUT_DEBUG=1 uvicorn unilabos.layout_optimizer.server:app --host 0.0.0.0 --port 8000 --reload
日志文件:
自动写入 layout_optimizer/logs/{YYYYMMDD_HHMMSS}.log始终 DEBUG 级别)。
前端 1s 轮询的 GET /scene/placements 200 行不写入日志文件。
前端访问:
http://localhost:8000/
"""
from __future__ import annotations
from collections import defaultdict
import itertools
import logging
import logging.handlers
import math
import os
from datetime import datetime
from pathlib import Path
from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import FileResponse, RedirectResponse
from fastapi.staticfiles import StaticFiles
from pydantic import BaseModel
from .constraints import DEFAULT_WEIGHT_ANGLE # noqa: F401 — kept for external use
from .device_catalog import (
create_devices_from_list,
load_devices_from_assets,
load_devices_from_registry,
load_footprints,
merge_device_lists,
)
from .lab_parser import parse_lab
from .intent_interpreter import InterpretResult, interpret_intents
from .models import Constraint, Intent
from .optimizer import optimize
_console_level = logging.DEBUG if os.getenv("LAYOUT_DEBUG") else logging.INFO
# root logger must be DEBUG so the file handler receives all records;
# console output level is controlled separately via its handler.
logging.basicConfig(level=logging.DEBUG)
# basicConfig creates a default StreamHandler — set its level to the console level
for _h in logging.getLogger().handlers:
if isinstance(_h, logging.StreamHandler):
_h.setLevel(_console_level)
logger = logging.getLogger(__name__)
# --- 文件日志:实时写入 logs/ 目录,按启动时间命名 ---
_LOG_DIR = Path(__file__).parent / "logs"
_LOG_DIR.mkdir(exist_ok=True)
_log_file = _LOG_DIR / f"{datetime.now():%Y%m%d_%H%M%S}.log"
class _PollingFilter(logging.Filter):
"""过滤掉前端 1s 轮询产生的 GET /scene/placements 日志行。"""
def filter(self, record: logging.LogRecord) -> bool:
msg = record.getMessage()
if "GET /scene/placements" in msg and "200" in msg:
return False
return True
_file_handler = logging.FileHandler(_log_file, encoding="utf-8")
_file_handler.setLevel(logging.DEBUG)
_file_handler.setFormatter(
logging.Formatter("%(asctime)s %(levelname)-5s [%(name)s] %(message)s")
)
_file_handler.addFilter(_PollingFilter())
logging.getLogger().addHandler(_file_handler)
STATIC_DIR = Path(__file__).parent / "static"
# 可配置路径
# __file__ -> Uni-Lab-OS/unilabos/layout_optimizer/server.py
_UNILABOS_DIR = Path(__file__).resolve().parent.parent # .../Uni-Lab-OS/unilabos/
UNI_LAB_ASSETS_DIR = Path(
os.getenv("UNI_LAB_ASSETS_DIR", str(_UNILABOS_DIR.parent.parent.parent / "uni-lab-assets"))
)
UNI_LAB_ASSETS_MODELS_DIR = UNI_LAB_ASSETS_DIR / "device_models"
UNI_LAB_ASSETS_DATA_JSON = UNI_LAB_ASSETS_DIR / "data.json"
UNI_LAB_OS_DEVICE_MESH_DIR = Path(
os.getenv(
"UNI_LAB_OS_DEVICE_MESH_DIR",
str(_UNILABOS_DIR / "device_mesh" / "devices"),
)
)
app = FastAPI(title="Layout Optimizer", version="0.2.0")
app.add_middleware(
CORSMiddleware,
allow_origins=["*"], # 开发阶段允许所有来源
allow_methods=["*"],
allow_headers=["*"],
)
# 挂载静态文件目录
app.mount("/static", StaticFiles(directory=str(STATIC_DIR)), name="static")
# 挂载 3D 模型和缩略图
if UNI_LAB_ASSETS_MODELS_DIR.exists():
app.mount("/models", StaticFiles(directory=str(UNI_LAB_ASSETS_MODELS_DIR)), name="models")
logger.info("Mounted /models from %s", UNI_LAB_ASSETS_MODELS_DIR)
else:
logger.warning("uni-lab-assets models dir not found: %s", UNI_LAB_ASSETS_MODELS_DIR)
# ---------- 设备目录缓存 ----------
_device_cache: list[dict] | None = None
_DEVICE_PARAM_KEYS = {"device_a", "device_b", "arm_id", "target_device_id", "device"}
# 消耗品/配件关键词(不独立放置于实验台)
_CONSUMABLE_KEYWORDS = {
"plate", "well", "tube", "tip", "reservoir", "carrier", "nest",
"adapter", "trough", "magnet_module", "magnet_plate", "rack", "lid",
"seal", "cap", "vial", "flask", "dish", "block", "strip", "insert",
"gasket", "pad", "grid_segment", "spacer", "diti_tray",
}
# 但包含这些关键词的是独立设备,不是消耗品
_DEVICE_KEYWORDS = {
"reader", "handler", "hotel", "washer", "stacker", "sealer", "labeler",
"centrifuge", "incubator", "shaker", "robot", "arm", "flex", "dispenser",
"printer", "scanner", "analyzer", "fluorometer", "spectrophotometer",
"thermocycler", "module",
}
def _is_standalone_device(device_id: str, bbox: tuple[float, float]) -> bool:
"""判断设备是否独立放置于实验台(非消耗品/配件)。"""
mx = max(bbox[0], bbox[1])
mn = min(bbox[0], bbox[1])
if mx >= 0.30:
return True # 大于 30cm 一定是独立设备
if mx < 0.05:
return False # 小于 5cm 一定是消耗品
lower = device_id.lower()
# 非常扁平(一维 < 3cm的几乎都是配件/载具,即使名称匹配设备关键词
if mn < 0.03:
return False
# 先检查消耗品关键词(如果匹配,再看是否有设备关键词覆盖)
is_consumable_name = any(kw in lower for kw in _CONSUMABLE_KEYWORDS)
is_device_name = any(kw in lower for kw in _DEVICE_KEYWORDS)
if is_consumable_name and not is_device_name:
return False
if is_device_name:
return True
# 默认:>= 15cm 视为设备
return mx >= 0.15
def _build_device_list() -> list[dict]:
"""构建合并后的设备列表(缓存)。"""
global _device_cache
if _device_cache is not None:
return _device_cache
footprints = load_footprints()
registry = load_devices_from_registry(UNI_LAB_OS_DEVICE_MESH_DIR, footprints)
assets = load_devices_from_assets(UNI_LAB_ASSETS_DATA_JSON, footprints)
merged = merge_device_lists(registry, assets)
_device_cache = [
{
"id": d.id,
"name": d.name,
"device_type": d.device_type,
"source": d.source,
"bbox": list(d.bbox),
"height": d.height,
"origin_offset": list(d.origin_offset),
"openings": [
{"direction": list(o.direction), "label": o.label}
for o in d.openings
],
"model_path": d.model_path,
"model_type": d.model_type,
"thumbnail_url": d.thumbnail_url,
"is_standalone": _is_standalone_device(d.id, d.bbox),
}
for d in merged
]
standalone = sum(1 for d in _device_cache if d["is_standalone"])
logger.info("Built device catalog: %d devices (%d standalone)", len(_device_cache), standalone)
return _device_cache
def _catalog_id_from_internal(device_id: str) -> str:
"""内部实例 ID → catalog ID。"""
return device_id.split("#", 1)[0]
def _expand_constraints_for_duplicates(
constraints: list[Constraint], devices: list,
) -> list[Constraint]:
"""将引用 bare catalog ID 的约束扩展到所有重复实例。"""
catalog_instances: dict[str, list[str]] = defaultdict(list)
for dev in devices:
catalog_instances[_catalog_id_from_internal(dev.id)].append(dev.id)
expanded_constraints: list[Constraint] = []
for constraint in constraints:
fan_out_keys: list[str] = []
fan_out_values: list[list[str]] = []
for key in _DEVICE_PARAM_KEYS:
if key not in constraint.params:
continue
ref_id = constraint.params[key]
if "#" in ref_id:
continue
instances = catalog_instances.get(ref_id, [])
if len(instances) > 1:
fan_out_keys.append(key)
fan_out_values.append(instances)
logger.info(
"Fan-out: %s %s=%s -> %d instances",
constraint.rule_name, key, ref_id, len(instances),
)
if not fan_out_keys:
expanded_constraints.append(constraint)
continue
for combo in itertools.product(*fan_out_values):
new_params = dict(constraint.params)
for key, internal_id in zip(fan_out_keys, combo):
new_params[key] = internal_id
expanded_constraints.append(
Constraint(
type=constraint.type,
rule_name=constraint.rule_name,
params=new_params,
weight=constraint.weight,
)
)
return expanded_constraints
def _maybe_add_prefer_aligned_constraint(
constraints: list[Constraint], align_weight: float,
) -> list[Constraint]:
"""仅在用户未显式提供 prefer_aligned 时注入对齐约束。"""
if align_weight <= 0:
return constraints
if any(c.rule_name == "prefer_aligned" for c in constraints):
logger.info("Skipping auto-injected prefer_aligned because one already exists")
return constraints
constraints.append(
Constraint(
type="soft",
rule_name="prefer_aligned",
weight=align_weight,
)
)
return constraints
# ---------- 路由 ----------
@app.get("/", include_in_schema=False)
async def root():
return RedirectResponse(url="/lab3d")
@app.get("/lab3d", include_in_schema=False)
async def lab3d_ui():
return FileResponse(STATIC_DIR / "lab3d.html")
@app.get("/devices")
async def list_devices(source: str = "all"):
"""返回合并后的设备目录。?source=registry|assets|all"""
devices = _build_device_list()
if source != "all":
devices = [d for d in devices if d["source"] == source]
return devices
@app.get("/health")
async def health():
return {"status": "ok"}
# ---------- 意图解释 API ----------
class IntentSpec(BaseModel):
intent: str
params: dict = {}
description: str = ""
class TranslationEntry(BaseModel):
source_intent: str
source_description: str
source_params: dict
generated_constraints: list[dict]
explanation: str
confidence: str = "high"
class InterpretRequest(BaseModel):
intents: list[IntentSpec]
class InterpretResponse(BaseModel):
constraints: list[dict]
translations: list[TranslationEntry]
workflow_edges: list[list[str]]
errors: list[str]
@app.post("/interpret", response_model=InterpretResponse)
async def run_interpret(request: InterpretRequest):
"""将语义化意图翻译为约束列表,供用户确认后传入 /optimize。"""
logger.info("Interpret request: %d intents", len(request.intents))
intents = [
Intent(
intent=i.intent,
params=i.params,
description=i.description,
)
for i in request.intents
]
result: InterpretResult = interpret_intents(intents)
return InterpretResponse(
constraints=[
{"type": c.type, "rule_name": c.rule_name, "params": c.params, "weight": c.weight}
for c in result.constraints
],
translations=[
TranslationEntry(
source_intent=t["source_intent"],
source_description=t.get("source_description", ""),
source_params=t.get("source_params", {}),
generated_constraints=t["generated_constraints"],
explanation=t["explanation"],
confidence=t.get("confidence", "high"),
)
for t in result.translations
],
workflow_edges=result.workflow_edges,
errors=result.errors,
)
@app.get("/interpret/schema")
async def interpret_schema():
"""返回可用意图类型及其参数规范,供 LLM agent 发现和使用。"""
return {
"description": "Layout optimizer intent schema. LLM agents should translate user requests into these intents.",
"intents": {
"reachable_by": {
"description": "Robot arm must be able to reach all target devices",
"params": {
"arm": {"type": "string", "required": True, "description": "Device ID of robot arm"},
"targets": {"type": "list[string]", "required": True, "description": "Device IDs the arm must reach"},
},
"generates": "hard reachability constraint per target",
},
"close_together": {
"description": "Group of devices should be placed near each other",
"params": {
"devices": {"type": "list[string]", "required": True, "description": "Device IDs (min 2)"},
"priority": {"type": "string", "required": False, "default": "medium", "enum": ["low", "medium", "high"]},
},
"generates": "soft minimize_distance for each pair",
},
"far_apart": {
"description": "Devices should be placed far from each other",
"params": {
"devices": {"type": "list[string]", "required": True, "description": "Device IDs (min 2)"},
"priority": {"type": "string", "required": False, "default": "medium", "enum": ["low", "medium", "high"]},
},
"generates": "soft maximize_distance for each pair",
},
"keep_adjacent": {
"description": "Devices should stay adjacent, similar to close_together",
"params": {
"devices": {"type": "list[string]", "required": True, "description": "Device IDs (min 2)"},
"priority": {"type": "string", "required": False, "default": "medium", "enum": ["low", "medium", "high"]},
},
"generates": "soft minimize_distance for each pair",
},
"max_distance": {
"description": "Two devices must be within a maximum distance",
"params": {
"device_a": {"type": "string", "required": True},
"device_b": {"type": "string", "required": True},
"distance": {"type": "float", "required": True, "description": "Max edge-to-edge distance in meters"},
},
"generates": "hard distance_less_than",
},
"min_distance": {
"description": "Two devices must be at least a minimum distance apart",
"params": {
"device_a": {"type": "string", "required": True},
"device_b": {"type": "string", "required": True},
"distance": {"type": "float", "required": True, "description": "Min edge-to-edge distance in meters"},
},
"generates": "hard distance_greater_than",
},
"min_spacing": {
"description": "Minimum gap between all device pairs",
"params": {
"min_gap": {"type": "float", "required": False, "default": 0.3, "description": "Minimum gap in meters"},
},
"generates": "hard min_spacing",
},
"workflow_hint": {
"description": "Workflow step order — consecutive devices should be near each other",
"params": {
"workflow": {"type": "string", "required": False, "description": "Workflow name (e.g. 'pcr')"},
"devices": {"type": "list[string]", "required": True, "description": "Ordered device IDs following workflow steps"},
},
"generates": "soft minimize_distance for consecutive pairs + workflow_edges",
},
"face_outward": {
"description": "Devices should face outward from lab center",
"params": {},
"generates": "soft prefer_orientation_mode outward",
},
"face_inward": {
"description": "Devices should face inward toward lab center",
"params": {},
"generates": "soft prefer_orientation_mode inward",
},
"align_cardinal": {
"description": "Devices should align to cardinal directions (0/90/180/270 degrees)",
"params": {},
"generates": "soft prefer_aligned",
},
},
}
# ---------- 优化 API ----------
class DeviceSpec(BaseModel):
id: str
name: str = ""
size: list[float] | None = None
device_type: str = "static"
uuid: str = ""
class ConstraintSpec(BaseModel):
type: str # "hard" or "soft"
rule_name: str
params: dict = {}
weight: float = 1.0
class LabSpec(BaseModel):
width: float
depth: float
obstacles: list[dict] = []
class OptimizeRequest(BaseModel):
devices: list[DeviceSpec]
lab: LabSpec
constraints: list[ConstraintSpec] = []
seeder: str = "compact_outward"
seeder_overrides: dict = {}
run_de: bool = True
workflow_edges: list[list[str]] = []
maxiter: int = 200
seed: int | None = None
snap_cardinal: bool = False
angle_granularity: int | None = None
arm_reach: dict[str, float] = {}
# DE 超参数
strategy: str = "currenttobest1bin"
angle_mode: str = "joint"
mutation: list[float] = [0.5, 1.0]
theta_mutation: list[float] | None = None
recombination: float = 0.7
crossover_mode: str = "device"
class PositionXYZ(BaseModel):
x: float
y: float
z: float
class PlacementResult(BaseModel):
device_id: str
uuid: str
position: PositionXYZ
rotation: PositionXYZ
class OptimizeResponse(BaseModel):
placements: list[PlacementResult]
cost: float
success: bool
seeder_used: str = ""
de_ran: bool = True
@app.post("/optimize", response_model=OptimizeResponse)
async def run_optimize(request: OptimizeRequest):
"""接收设备列表+约束,返回最优布局方案。"""
from fastapi import HTTPException
from .constraints import evaluate_default_hard_constraints, evaluate_constraints
from .mock_checkers import MockCollisionChecker, MockReachabilityChecker
from .optimizer import optimize, snap_theta, snap_theta_safe
from .seeders import resolve_seeder_params, seed_layout
logger.info(
"Optimize request: %d devices, lab %.1f×%.1f, %d constraints, seeder=%s, run_de=%s, angle_granularity=%s",
len(request.devices),
request.lab.width,
request.lab.depth,
len(request.constraints),
request.seeder,
request.run_de,
request.angle_granularity,
)
if request.angle_granularity not in (None, 4, 8, 12, 24):
raise HTTPException(
status_code=400,
detail="angle_granularity must be one of: 4, 8, 12, 24",
)
# 转换输入
devices = create_devices_from_list(
[d.model_dump() for d in request.devices]
)
id_to_catalog = {dev.id: _catalog_id_from_internal(dev.id) for dev in devices}
id_to_uuid = {dev.id: (dev.uuid or dev.id) for dev in devices}
lab = parse_lab(request.lab.model_dump())
constraints = [
Constraint(
type=c.type,
rule_name=c.rule_name,
params=c.params,
weight=c.weight,
)
for c in request.constraints
]
constraints = _expand_constraints_for_duplicates(constraints, devices)
# 1. Resolve seeder
try:
params = resolve_seeder_params(request.seeder, request.seeder_overrides or None)
except ValueError as e:
raise HTTPException(status_code=400, detail=str(e))
# 2. Seed
seed_placements = seed_layout(
devices, lab, params,
request.workflow_edges or None,
)
# 3. Auto-inject alignment soft constraint (opt-in via seeder_overrides)
if request.run_de and seed_placements:
# prefer_aligned: penalize non-cardinal angles默认关闭用户可通过 align_cardinal intent 或 seeder_overrides 开启)
constraints = _maybe_add_prefer_aligned_constraint(
constraints,
request.seeder_overrides.get("align_weight", 0),
)
# 4. Validate DE hyperparameters
if request.strategy not in {"currenttobest1bin", "best1bin", "rand1bin"}:
raise HTTPException(
status_code=400,
detail=f"strategy must be one of: currenttobest1bin, best1bin, rand1bin (got {request.strategy!r})",
)
if request.angle_mode not in {"joint", "hybrid"}:
raise HTTPException(
status_code=400,
detail=f"angle_mode must be one of: joint, hybrid (got {request.angle_mode!r})",
)
if request.crossover_mode not in {"device", "dimension"}:
raise HTTPException(
status_code=400,
detail=f"crossover_mode must be one of: device, dimension (got {request.crossover_mode!r})",
)
if len(request.mutation) != 2 or request.mutation[0] > request.mutation[1]:
raise HTTPException(status_code=400, detail="mutation must be [F_min, F_max] with F_min <= F_max")
if request.mutation[0] < 0 or request.mutation[1] > 2.0:
raise HTTPException(status_code=400, detail="mutation values must be in [0, 2.0]")
if request.theta_mutation is not None:
if len(request.theta_mutation) != 2 or request.theta_mutation[0] > request.theta_mutation[1]:
raise HTTPException(status_code=400, detail="theta_mutation must be [F_min, F_max] with F_min <= F_max")
if request.theta_mutation[0] < 0 or request.theta_mutation[1] > 2.0:
raise HTTPException(status_code=400, detail="theta_mutation values must be in [0, 2.0]")
if not (0 <= request.recombination <= 1.0):
raise HTTPException(status_code=400, detail="recombination must be in [0, 1.0]")
# 5. Conditional Differential Evolution
de_ran = False
checker = MockCollisionChecker()
reachability_checker = MockReachabilityChecker(request.arm_reach or None)
if request.run_de:
result_placements = optimize(
devices=devices,
lab=lab,
constraints=constraints,
collision_checker=checker,
reachability_checker=reachability_checker,
seed_placements=seed_placements,
maxiter=request.maxiter,
seed=request.seed,
strategy=request.strategy,
workflow_edges=request.workflow_edges or None,
angle_granularity=request.angle_granularity,
angle_mode=request.angle_mode,
mutation=tuple(request.mutation),
theta_mutation=tuple(request.theta_mutation) if request.theta_mutation else None,
recombination=request.recombination,
crossover_mode=request.crossover_mode,
)
de_ran = True
else:
result_placements = seed_placements
# 5. θ snap post-processingopt-in默认关闭
if request.snap_cardinal and request.angle_granularity is None:
result_placements = snap_theta_safe(result_placements, devices, lab, checker)
elif request.snap_cardinal and request.angle_granularity is not None:
logger.info(
"snap_cardinal ignored because angle_granularity=%s already constrains theta",
request.angle_granularity,
)
# 6. Evaluate final cost (binary mode for pass/fail reporting)
final_cost = evaluate_default_hard_constraints(
devices, result_placements, lab, checker, graduated=False,
)
# 也检查用户硬约束binary 模式)
if constraints and not math.isinf(final_cost):
user_hard_cost = evaluate_constraints(
devices, result_placements, lab, constraints, checker, reachability_checker,
graduated=False,
)
if math.isinf(user_hard_cost):
final_cost = math.inf
return OptimizeResponse(
placements=[
PlacementResult(
device_id=id_to_catalog.get(p.device_id, p.device_id),
uuid=id_to_uuid.get(p.device_id, p.device_id),
position=PositionXYZ(x=round(p.x, 4), y=round(p.y, 4), z=0.0),
rotation=PositionXYZ(x=0.0, y=0.0, z=round(p.theta, 4)),
)
for p in result_placements
],
cost=final_cost,
success=not math.isinf(final_cost),
seeder_used=request.seeder,
de_ran=de_ran,
)
# ---------- 场景状态 API演示用 ----------
_scene_state: dict = {"version": 0, "placements": []}
_lab_state: dict = {"width": 4.0, "depth": 4.0}
class LabDimensions(BaseModel):
width: float
depth: float
@app.get("/scene/lab")
async def get_lab_dimensions():
"""返回当前实验室尺寸前端推送agent 读取)。"""
return _lab_state
@app.post("/scene/lab")
async def set_lab_dimensions(dims: LabDimensions):
"""前端在加载和尺寸变更时推送。"""
_lab_state["width"] = dims.width
_lab_state["depth"] = dims.depth
return _lab_state
class ScenePlacementsRequest(BaseModel):
placements: list[PlacementResult]
@app.post("/scene/placements")
async def set_scene_placements(request: ScenePlacementsRequest):
"""Agent 写入布局结果,前端轮询读取。"""
_scene_state["version"] += 1
_scene_state["placements"] = [p.model_dump() for p in request.placements]
logger.info(
"Scene placements updated: version=%d, count=%d",
_scene_state["version"],
len(request.placements),
)
return {"version": _scene_state["version"], "count": len(request.placements)}
@app.get("/scene/placements")
async def get_scene_placements():
"""前端轮询此端点,检测 version 变化后应用布局。"""
return _scene_state
@app.delete("/scene/placements")
async def clear_scene_placements():
"""重置场景状态(重录时使用)。"""
_scene_state["version"] = 0
_scene_state["placements"] = []
return {"version": 0, "placements": []}

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,7 @@
[
{"id": "arm_1", "name": "Elite CS66 Arm", "size": [0.20, 0.20], "device_type": "articulation"},
{"id": "liquid_handler", "name": "Agilent Bravo", "size": [0.80, 0.65], "device_type": "static"},
{"id": "centrifuge", "name": "Centrifuge", "size": [0.50, 0.50], "device_type": "static"},
{"id": "plate_hotel", "name": "Thermo Orbitor RS2", "size": [0.45, 0.55], "device_type": "static"},
{"id": "hplc", "name": "HPLC Station", "size": [0.60, 0.50], "device_type": "static"}
]

View File

@@ -0,0 +1,7 @@
{
"width": 5.0,
"depth": 4.0,
"obstacles": [
{"x": 2.5, "y": 0.0, "width": 0.1, "depth": 0.5}
]
}

View File

@@ -0,0 +1,241 @@
"""Tests for broad_phase.py — 2 轴 sweep-and-prune 宽相碰撞检测。"""
from __future__ import annotations
import math
import random
import pytest
from ..broad_phase import broad_phase_device_pairs, sweep_and_prune_pairs
from ..models import Device, Placement
# ---------------------------------------------------------------------------
# 测试用辅助函数
# ---------------------------------------------------------------------------
def _make_device(device_id: str, w: float = 0.6, d: float = 0.4) -> Device:
"""创建简单测试设备。"""
return Device(id=device_id, name=device_id, bbox=(w, d))
def _make_placement(
device_id: str, x: float, y: float, theta: float = 0.0
) -> Placement:
"""创建简单测试放置。"""
return Placement(device_id=device_id, x=x, y=y, theta=theta)
# ---------------------------------------------------------------------------
# 测试类
# ---------------------------------------------------------------------------
class TestNoOverlap:
"""两台设备距离足够远,宽相不返回候选对。"""
def test_no_overlap_returns_empty(self):
"""水平方向间距远大于 AABB 尺寸 → 0 候选对。"""
devices = [_make_device("A", 1.0, 1.0), _make_device("B", 1.0, 1.0)]
placements = [
_make_placement("A", 0.0, 0.0),
_make_placement("B", 10.0, 0.0),
]
pairs = sweep_and_prune_pairs(devices, placements)
assert pairs == []
class TestOverlapping:
"""两台设备 AABB 明显重叠。"""
def test_overlapping_devices_returned(self):
"""两台 1×1 设备中心距 0.5m → 1 候选对。"""
devices = [_make_device("A", 1.0, 1.0), _make_device("B", 1.0, 1.0)]
placements = [
_make_placement("A", 0.0, 0.0),
_make_placement("B", 0.5, 0.0),
]
pairs = sweep_and_prune_pairs(devices, placements)
assert len(pairs) == 1
assert pairs[0] == (0, 1)
class TestXOverlapYNoOverlap:
"""x 轴投影交叠但 y 轴不交叠,应被 y 轴检查剪枝。"""
def test_x_overlap_y_no_overlap(self):
"""水平接近但垂直方向偏移足够大 → 0 候选对。"""
devices = [_make_device("A", 2.0, 1.0), _make_device("B", 2.0, 1.0)]
placements = [
_make_placement("A", 0.0, 0.0),
_make_placement("B", 0.5, 5.0), # x 轴交叠但 y 轴相距很远
]
pairs = sweep_and_prune_pairs(devices, placements)
assert pairs == []
class TestTouchingDevices:
"""AABB 恰好接触(边缘距离 = 0应作为候选对返回。"""
def test_touching_devices_included(self):
"""两个 1×1 设备中心距恰好为 1.0(半宽 0.5 + 0.5 = 1.0
AABB 边界接触 → 应包含在候选对中(<= 判定)。"""
devices = [_make_device("A", 1.0, 1.0), _make_device("B", 1.0, 1.0)]
placements = [
_make_placement("A", 0.0, 0.0),
_make_placement("B", 1.0, 0.0), # xmax_A = 0.5, xmin_B = 0.5 → 接触
]
pairs = sweep_and_prune_pairs(devices, placements)
# 接触算作潜在碰撞,安全起见需保留
assert len(pairs) == 1
assert pairs[0] == (0, 1)
class TestMultipleDevices:
"""4 台设备验证精确的候选对列表。"""
def test_multiple_devices_correct_pairs(self):
"""排列 4 台设备,只有特定配对 AABB 交叠。
布局1×1 设备):
A(0,0) B(0.8,0) — A-B 交叠(中心距 0.8 < 1.0
C(0,5) — 远离 A、B
D(0.9,5) — C-D 交叠(中心距 0.9 < 1.0
期望候选对: (A,B) 和 (C,D)。
"""
devices = [
_make_device("A", 1.0, 1.0),
_make_device("B", 1.0, 1.0),
_make_device("C", 1.0, 1.0),
_make_device("D", 1.0, 1.0),
]
placements = [
_make_placement("A", 0.0, 0.0),
_make_placement("B", 0.8, 0.0),
_make_placement("C", 0.0, 5.0),
_make_placement("D", 0.9, 5.0),
]
pairs = sweep_and_prune_pairs(devices, placements)
pair_set = set(pairs)
assert (0, 1) in pair_set # A-B
assert (2, 3) in pair_set # C-D
assert len(pair_set) == 2
class TestRotatedDeviceAabb:
"""旋转设备导致 AABB 变大,命中候选对。"""
def test_rotated_device_aabb(self):
"""一台窄长设备 (2.0×0.2)
- 未旋转时 AABB 半宽 = 1.0,两设备中心距 2.5 → 不交叠
- 旋转 90° 后 AABB 半宽 = 0.1,半深 = 1.0 → 仍不交叠
- 旋转 45° 后 AABB 半宽 ≈ (2*cos45 + 0.2*sin45)/2 ≈ 0.778
但另一台放在 x=1.6,半宽 = 1.0
所以 xmax_A = 0 + 0.778 = 0.778 < 1.6 - 1.0 = 0.6 → 不够
更好的方案:用中心距 1.5,未旋转时不交叠,旋转后交叠。
未旋转: half_w_A = 0.3 (bbox 0.6x2.0), half_w_B = 0.3
A: xmax = 0 + 0.3 = 0.3, B: xmin = 1.5 - 0.3 = 1.2 → 不交叠
旋转 90°: A 的 bbox (0.6, 2.0) → half_w = (0.6*0 + 2.0*1)/2 = 1.0
A: xmax = 0 + 1.0 = 1.0, B: xmin = 1.5 - 0.3 = 1.2 → 仍不交叠
用 bbox (0.4, 2.0),间距 1.2
未旋转: half_w = 0.2, xmax_A = 0.2, xmin_B = 1.2 - 0.2 = 1.0 → 不交叠
旋转 45°: half_w = (0.4*cos45 + 2.0*sin45)/2 = (0.283+1.414)/2 = 0.849
xmax_A = 0.849, xmin_B = 1.2 - 0.2 = 1.0 → 不交叠
间距 0.8
未旋转: xmax_A = 0.2, xmin_B = 0.8 - 0.2 = 0.6 → 不交叠 ✓
旋转 45°: xmax_A = 0.849, xmin_B = 0.6 → 交叠 ✓ (0.849 > 0.6)
y 轴: half_d_A_rot = (0.4*sin45 + 2.0*cos45)/2 = 0.849, half_d_B = 1.0
ymax_A = 0.849, ymin_B = -1.0 → 交叠 ✓
"""
dev_narrow = _make_device("narrow", 0.4, 2.0)
dev_normal = _make_device("normal", 0.4, 2.0)
# 未旋转:不交叠
placements_no_rot = [
_make_placement("narrow", 0.0, 0.0, theta=0.0),
_make_placement("normal", 0.8, 0.0, theta=0.0),
]
assert sweep_and_prune_pairs([dev_narrow, dev_normal], placements_no_rot) == []
# narrow 旋转 45° → AABB 变大 → 交叠
placements_rot = [
_make_placement("narrow", 0.0, 0.0, theta=math.pi / 4),
_make_placement("normal", 0.8, 0.0, theta=0.0),
]
pairs = sweep_and_prune_pairs([dev_narrow, dev_normal], placements_rot)
assert len(pairs) == 1
class TestOriginalIndices:
"""验证返回的索引对应 placements 原始顺序而非排序后顺序。"""
def test_sorted_output_preserves_original_indices(self):
"""故意让 placements 按 x 坐标逆序排列,
验证返回的索引仍是原始顺序。"""
devices = [
_make_device("A", 1.0, 1.0),
_make_device("B", 1.0, 1.0),
_make_device("C", 1.0, 1.0),
]
# 逆序排列C 在最左A 在最右
placements = [
_make_placement("A", 5.0, 0.0), # idx 0, 最右
_make_placement("B", 4.5, 0.0), # idx 1, 中间(与 A 交叠)
_make_placement("C", 0.0, 0.0), # idx 2, 最左(独立)
]
pairs = sweep_and_prune_pairs(devices, placements)
# A(idx=0) 和 B(idx=1) AABB 交叠,索引应为 (0, 1)
assert len(pairs) == 1
assert pairs[0] == (0, 1)
# 同时验证 broad_phase_device_pairs 返回正确 device_id
id_pairs = broad_phase_device_pairs(devices, placements)
assert id_pairs == [("A", "B")]
class TestPairCountReduction:
"""大规模随机测试:宽相候选对数应远小于 N*(N-1)/2。"""
def test_pair_count_reduction(self):
"""N=15 台设备随机放置在 10×10 实验室 → 候选对数显著少于全量。"""
random.seed(42)
n = 15
devices = [_make_device(f"D{i}", 0.5, 0.5) for i in range(n)]
placements = [
_make_placement(f"D{i}", random.uniform(0, 10), random.uniform(0, 10))
for i in range(n)
]
pairs = sweep_and_prune_pairs(devices, placements)
full_pairs = n * (n - 1) // 2 # = 105
# 在 10×10 区域放 15 台 0.5×0.5 设备,交叠率应很低
assert len(pairs) < full_pairs
# 额外断言:候选对数不超过全量的一半(保守判定)
assert len(pairs) < full_pairs * 0.5
class TestEdgeCases:
"""边界情况。"""
def test_empty_input(self):
"""空列表 → 空结果。"""
assert sweep_and_prune_pairs([], []) == []
def test_single_device(self):
"""单台设备 → 无候选对。"""
devices = [_make_device("A")]
placements = [_make_placement("A", 0.0, 0.0)]
assert sweep_and_prune_pairs(devices, placements) == []
def test_identical_positions(self):
"""两台设备完全重叠 → 1 候选对。"""
devices = [_make_device("A", 1.0, 1.0), _make_device("B", 1.0, 1.0)]
placements = [
_make_placement("A", 0.0, 0.0),
_make_placement("B", 0.0, 0.0),
]
pairs = sweep_and_prune_pairs(devices, placements)
assert len(pairs) == 1

View File

@@ -0,0 +1,435 @@
"""Regression tests for V2 Stage 1 bugfixes.
Covers:
- Duplicate device ID stacking (catalog ID + #N internal IDs)
- DE orientation preservation (prefer_orientation_mode constraint)
- prefer_aligned auto-injection and adjustability
- Preset switch reorientation
- min_spacing with duplicate catalog IDs
"""
import math
import pytest
from ..constraints import evaluate_constraints
from ..mock_checkers import MockCollisionChecker
from ..models import Constraint, Device, Lab, Opening, Placement
from ..obb import obb_corners, obb_overlap
from ..optimizer import (
_placements_to_vector,
_vector_to_placements,
optimize,
snap_theta,
)
from ..seeders import resolve_seeder_params, seed_layout
# ── Helpers ─────────────────────────────────────────────
def _ot(uid: str) -> Device:
return Device(
id=uid, name="Opentrons Liquid Handler",
bbox=(0.6243, 0.5672), openings=[Opening(direction=(0.0, -1.0))],
)
def _tecan(uid: str) -> Device:
return Device(
id=uid, name="Tecan EVO 100",
bbox=(0.8121, 0.8574), openings=[Opening(direction=(0.0, -1.0))],
)
def _facing_dot(p: Placement, device: Device, lab: Lab) -> float:
"""Dot product of rotated front vector with vector from center to device.
Positive = outward, negative = inward."""
cx, cy = lab.width / 2, lab.depth / 2
dx, dy = p.x - cx, p.y - cy
front = device.openings[0].direction if device.openings else (0.0, -1.0)
rf_x = math.cos(p.theta) * front[0] - math.sin(p.theta) * front[1]
rf_y = math.sin(p.theta) * front[0] + math.cos(p.theta) * front[1]
return rf_x * dx + rf_y * dy
def _has_collision(devices, placements):
for i in range(len(devices)):
for j in range(i + 1, len(devices)):
ci = obb_corners(placements[i].x, placements[i].y,
devices[i].bbox[0], devices[i].bbox[1], placements[i].theta)
cj = obb_corners(placements[j].x, placements[j].y,
devices[j].bbox[0], devices[j].bbox[1], placements[j].theta)
if obb_overlap(ci, cj):
return True
return False
# ── Bug 1: Duplicate device ID stacking ────────────────
class TestDuplicateDeviceIDs:
"""When two instances of the same catalog device are placed,
unique uuid-based IDs must prevent dict-key collisions."""
def test_vector_roundtrip_preserves_unique_positions(self):
"""_placements_to_vector → _vector_to_placements with unique IDs."""
devices = [_ot("uuid-a"), _ot("uuid-b")]
placements = [
Placement(device_id="uuid-a", x=0.5, y=0.5, theta=0.0),
Placement(device_id="uuid-b", x=1.5, y=1.5, theta=1.0),
]
vec = _placements_to_vector(placements, devices)
decoded = _vector_to_placements(vec, devices)
assert decoded[0].x == pytest.approx(0.5)
assert decoded[1].x == pytest.approx(1.5)
def test_min_spacing_detects_stacked_unique_ids(self):
"""min_spacing should detect two devices at the same position
when they have unique IDs."""
devices = [_ot("uuid-a"), _ot("uuid-b")]
stacked = [
Placement(device_id="uuid-a", x=1.0, y=1.0, theta=0.0),
Placement(device_id="uuid-b", x=1.0, y=1.0, theta=0.0),
]
lab = Lab(width=5, depth=5)
constraints = [Constraint(type="hard", rule_name="min_spacing",
params={"min_gap": 0.05})]
# graduated=True (default): 返回有限惩罚
cost = evaluate_constraints(devices, stacked, lab, constraints,
MockCollisionChecker())
assert cost > 0
assert not math.isinf(cost)
# graduated=False: binary inf
cost_binary = evaluate_constraints(devices, stacked, lab, constraints,
MockCollisionChecker(),
graduated=False)
assert math.isinf(cost_binary)
def test_create_devices_uses_catalog_id_with_suffixes(self):
"""create_devices_from_list should keep catalog IDs and suffix duplicates."""
from ..device_catalog import create_devices_from_list
specs = [
{"id": "opentrons_liquid_handler", "uuid": "abc-123"},
{"id": "opentrons_liquid_handler", "uuid": "def-456"},
]
devices = create_devices_from_list(specs)
assert devices[0].id == "opentrons_liquid_handler"
assert devices[1].id == "opentrons_liquid_handler#2"
assert devices[0].uuid == "abc-123"
assert devices[1].uuid == "def-456"
# Both should have the same bbox from footprints
assert devices[0].bbox == devices[1].bbox
def test_create_devices_fallback_no_uuid(self):
"""Without uuid, Device.id falls back to catalog id."""
from ..device_catalog import create_devices_from_list
specs = [{"id": "opentrons_liquid_handler"}]
devices = create_devices_from_list(specs)
assert devices[0].id == "opentrons_liquid_handler"
# ── Bug 2 & 4: DE orientation preservation ─────────────
class TestOrientationWithDE:
"""DE must preserve seeder orientation direction (outward/inward)
via the prefer_orientation_mode constraint."""
def _run_de_with_orientation(self, mode, seed_val=42):
devices = [_ot("ot1"), _ot("ot2"), _tecan("tecan")]
lab = Lab(width=2.0, depth=2.0)
params = resolve_seeder_params(
"compact_outward" if mode == "outward" else "spread_inward"
)
seed = seed_layout(devices, lab, params)
constraints = [
Constraint(type="hard", rule_name="min_spacing",
params={"min_gap": 0.05}),
Constraint(type="soft", rule_name="prefer_orientation_mode",
params={"mode": mode}, weight=5.0),
Constraint(type="soft", rule_name="prefer_aligned", weight=2.0),
]
result = optimize(devices, lab, constraints, seed_placements=seed,
maxiter=200, seed=seed_val)
result = snap_theta(result)
return devices, lab, result
def test_compact_outward_de_faces_outward(self):
devices, lab, result = self._run_de_with_orientation("outward")
for i, p in enumerate(result):
dot = _facing_dot(p, devices[i], lab)
assert dot > 0, (
f"{p.device_id} faces inward (dot={dot:.3f}) "
f"at ({p.x:.2f},{p.y:.2f}) theta={math.degrees(p.theta):.0f}°"
)
def test_spread_inward_de_faces_inward(self):
devices, lab, result = self._run_de_with_orientation("inward")
for i, p in enumerate(result):
dot = _facing_dot(p, devices[i], lab)
assert dot < 0, (
f"{p.device_id} faces outward (dot={dot:.3f}) "
f"at ({p.x:.2f},{p.y:.2f}) theta={math.degrees(p.theta):.0f}°"
)
def test_switching_preset_changes_orientation(self):
"""Switching from outward to inward should produce opposite facing."""
_, lab, out_result = self._run_de_with_orientation("outward")
devices_in, _, in_result = self._run_de_with_orientation("inward")
# At least one device should have different facing
out_dots = [_facing_dot(p, devices_in[i], lab) for i, p in enumerate(out_result)]
in_dots = [_facing_dot(p, devices_in[i], lab) for i, p in enumerate(in_result)]
# Outward: all positive; inward: all negative
assert all(d > 0 for d in out_dots), f"outward dots: {out_dots}"
assert all(d < 0 for d in in_dots), f"inward dots: {in_dots}"
def test_no_collision_after_de(self):
devices, lab, result = self._run_de_with_orientation("outward")
assert not _has_collision(devices, result)
# ── Bug 3: prefer_aligned & prefer_orientation_mode ────
class TestOrientationConstraints:
"""Test the new constraint rules directly."""
def test_prefer_orientation_mode_outward_zero_at_correct(self):
"""Zero cost when device faces outward from center."""
device = _ot("a")
# Device to the right of center, front pointing right
# front=(0,-1), theta=pi/2 → rotated front = (1, 0) = rightward
lab = Lab(width=4, depth=4)
placements = [Placement("a", 3.0, 2.0, math.pi / 2)]
constraint = Constraint(
type="soft", rule_name="prefer_orientation_mode",
params={"mode": "outward"}, weight=1.0,
)
cost = evaluate_constraints(
[device], placements, lab, [constraint], MockCollisionChecker(),
)
assert cost == pytest.approx(0.0, abs=0.01)
def test_prefer_orientation_mode_outward_penalty_at_inward(self):
"""High cost when device faces inward (opposite of outward)."""
device = _ot("a")
# Device to the right of center, front pointing left (inward)
# front=(0,-1), theta=3*pi/2 → rotated front = (-1, 0) = leftward
lab = Lab(width=4, depth=4)
placements = [Placement("a", 3.0, 2.0, 3 * math.pi / 2)]
constraint = Constraint(
type="soft", rule_name="prefer_orientation_mode",
params={"mode": "outward"}, weight=1.0,
)
cost = evaluate_constraints(
[device], placements, lab, [constraint], MockCollisionChecker(),
)
# 180° off → (1 - cos(pi)) / 2 = 1.0
assert cost == pytest.approx(1.0, abs=0.05)
def test_prefer_orientation_mode_inward(self):
"""Zero cost when device faces inward."""
device = _ot("a")
# Device to the right of center, front pointing left (inward)
lab = Lab(width=4, depth=4)
placements = [Placement("a", 3.0, 2.0, 3 * math.pi / 2)]
constraint = Constraint(
type="soft", rule_name="prefer_orientation_mode",
params={"mode": "inward"}, weight=1.0,
)
cost = evaluate_constraints(
[device], placements, lab, [constraint], MockCollisionChecker(),
)
assert cost == pytest.approx(0.0, abs=0.01)
def test_prefer_seeder_orientation_zero_at_target(self):
"""Zero cost when theta matches target."""
device = Device(id="a", name="A", bbox=(0.5, 0.5))
lab = Lab(width=4, depth=4)
placements = [Placement("a", 2, 2, 1.5)]
constraint = Constraint(
type="soft", rule_name="prefer_seeder_orientation",
params={"target_thetas": {"a": 1.5}}, weight=1.0,
)
cost = evaluate_constraints(
[device], placements, lab, [constraint], MockCollisionChecker(),
)
assert cost == pytest.approx(0.0, abs=1e-9)
def test_prefer_seeder_orientation_penalty_at_deviation(self):
"""Non-zero cost when theta deviates from target."""
device = Device(id="a", name="A", bbox=(0.5, 0.5))
lab = Lab(width=4, depth=4)
placements = [Placement("a", 2, 2, math.pi)] # pi away from 0
constraint = Constraint(
type="soft", rule_name="prefer_seeder_orientation",
params={"target_thetas": {"a": 0.0}}, weight=1.0,
)
cost = evaluate_constraints(
[device], placements, lab, [constraint], MockCollisionChecker(),
)
# (1 - cos(pi)) / 2 = 1.0
assert cost == pytest.approx(1.0)
# ── API endpoint regression ────────────────────────────
class TestEndpointOrientation:
"""Test that /optimize injects orientation constraints."""
def test_endpoint_with_de_injects_orientation(self):
from fastapi.testclient import TestClient
from ..server import app
client = TestClient(app)
resp = client.post("/optimize", json={
"devices": [
{"id": "opentrons_liquid_handler", "uuid": "u1"},
{"id": "opentrons_liquid_handler", "uuid": "u2"},
],
"lab": {"width": 3, "depth": 3},
"seeder": "compact_outward",
"run_de": True,
"maxiter": 50,
"seed": 42,
})
assert resp.status_code == 200
data = resp.json()
# Both devices should have unique uuids in response
uuids = [p["uuid"] for p in data["placements"]]
assert len(set(uuids)) == 2, f"Expected 2 unique uuids, got {uuids}"
def test_endpoint_orientation_weight_override(self):
from fastapi.testclient import TestClient
from ..server import app
client = TestClient(app)
resp = client.post("/optimize", json={
"devices": [{"id": "opentrons_liquid_handler", "uuid": "u1"}],
"lab": {"width": 3, "depth": 3},
"seeder": "compact_outward",
"seeder_overrides": {"orientation_weight": 10, "align_weight": 0},
"run_de": True,
"maxiter": 50,
"seed": 42,
})
assert resp.status_code == 200
def test_endpoint_align_weight_zero_disables(self):
"""Setting align_weight=0 should not inject prefer_aligned."""
from fastapi.testclient import TestClient
from ..server import app
client = TestClient(app)
resp = client.post("/optimize", json={
"devices": [{"id": "opentrons_liquid_handler", "uuid": "u1"}],
"lab": {"width": 3, "depth": 3},
"seeder": "compact_outward",
"seeder_overrides": {"align_weight": 0},
"run_de": True,
"maxiter": 50,
"seed": 42,
})
assert resp.status_code == 200
# ── Broader scenario tests ─────────────────────────────
class TestScenarios:
"""End-to-end scenarios similar to user's real usage."""
def test_user_scenario_2ot_1tecan_compact_outward(self):
"""User's exact scenario: 2 OT + 1 Tecan in 2m×2m, compact outward."""
devices = [_ot("ot1"), _ot("ot2"), _tecan("tecan")]
lab = Lab(width=2.0, depth=2.0)
params = resolve_seeder_params("compact_outward")
seed = seed_layout(devices, lab, params)
constraints = [
Constraint(type="hard", rule_name="min_spacing",
params={"min_gap": 0.05}),
Constraint(type="soft", rule_name="prefer_orientation_mode",
params={"mode": "outward"}, weight=5.0),
Constraint(type="soft", rule_name="prefer_aligned", weight=2.0),
]
result = optimize(devices, lab, constraints, seed_placements=seed,
maxiter=200, seed=42)
result = snap_theta(result)
# No stacking
assert not _has_collision(devices, result)
# All outward
for i, p in enumerate(result):
assert _facing_dot(p, devices[i], lab) > 0
def test_4_medium_devices_mixed_openings(self):
"""4 devices with different opening directions."""
devices = [
Device(id="d0", name="D0", bbox=(0.5, 0.3), openings=[Opening((1, 0))]),
Device(id="d1", name="D1", bbox=(0.5, 0.3), openings=[Opening((-1, 0))]),
Device(id="d2", name="D2", bbox=(0.5, 0.3), openings=[Opening((0, -1))]),
Device(id="d3", name="D3", bbox=(0.5, 0.3), openings=[Opening((0, 1))]),
]
lab = Lab(width=3.0, depth=3.0)
params = resolve_seeder_params("compact_outward")
seed = seed_layout(devices, lab, params)
constraints = [
Constraint(type="hard", rule_name="min_spacing",
params={"min_gap": 0.05}),
Constraint(type="soft", rule_name="prefer_orientation_mode",
params={"mode": "outward"}, weight=5.0),
Constraint(type="soft", rule_name="prefer_aligned", weight=2.0),
]
result = optimize(devices, lab, constraints, seed_placements=seed,
maxiter=200, seed=42)
result = snap_theta(result)
assert not _has_collision(devices, result)
for i, p in enumerate(result):
assert _facing_dot(p, devices[i], lab) > 0
# ── V2 Stage 1: 默认关闭 cardinal snap/alignment ────────
class TestV2Stage1Bugfixes:
"""align_weight 默认为 0snap_cardinal 默认关闭。"""
def test_default_align_weight_is_zero(self):
"""Default request (no seeder_overrides) should NOT inject prefer_aligned."""
from fastapi.testclient import TestClient
from ..server import app
client = TestClient(app)
resp = client.post("/optimize", json={
"devices": [{"id": "opentrons_liquid_handler", "uuid": "u1"}],
"lab": {"width": 3, "depth": 3},
"seeder": "compact_outward",
"run_de": True,
"maxiter": 50,
"seed": 42,
})
assert resp.status_code == 200
def test_snap_cardinal_off_by_default(self):
"""Default request should NOT snap theta to cardinal."""
from fastapi.testclient import TestClient
from ..server import app
client = TestClient(app)
resp = client.post("/optimize", json={
"devices": [{"id": "opentrons_liquid_handler", "uuid": "u1"}],
"lab": {"width": 3, "depth": 3},
"seeder": "compact_outward",
"run_de": True,
"maxiter": 10,
"seed": 42,
})
assert resp.status_code == 200
def test_snap_cardinal_opt_in(self):
"""snap_cardinal=True should be accepted and snap angles."""
from fastapi.testclient import TestClient
from ..server import app
client = TestClient(app)
resp = client.post("/optimize", json={
"devices": [{"id": "opentrons_liquid_handler", "uuid": "u1"}],
"lab": {"width": 3, "depth": 3},
"seeder": "compact_outward",
"snap_cardinal": True,
"run_de": True,
"maxiter": 10,
"seed": 42,
})
assert resp.status_code == 200

View File

@@ -0,0 +1,505 @@
"""约束体系测试。"""
import math
import pytest
from ..constraints import (
_crossing_penalty,
_opening_surface_center,
DEFAULT_WEIGHT_DISTANCE,
evaluate_constraints,
evaluate_default_hard_constraints,
)
from ..mock_checkers import MockCollisionChecker, MockReachabilityChecker
from ..models import Constraint, Device, Opening, Placement, Lab
from ..obb import nearest_point_on_obb, obb_corners
def _make_devices():
return [
Device(id="a", name="Device A", bbox=(0.5, 0.5)),
Device(id="b", name="Device B", bbox=(0.5, 0.5)),
]
def _make_lab():
return Lab(width=5.0, depth=4.0)
class TestDefaultHardConstraints:
def test_no_collision_passes(self):
"""无碰撞的布局应返回 0。"""
devices = _make_devices()
placements = [
Placement("a", 1.0, 1.0, 0.0),
Placement("b", 3.0, 3.0, 0.0),
]
checker = MockCollisionChecker()
cost = evaluate_default_hard_constraints(devices, placements, _make_lab(), checker)
assert cost == 0.0
def test_collision_returns_graduated_penalty(self):
"""碰撞布局应返回正的graduated penalty非inf"""
devices = _make_devices()
placements = [
Placement("a", 1.0, 1.0, 0.0),
Placement("b", 1.2, 1.0, 0.0),
]
checker = MockCollisionChecker()
cost = evaluate_default_hard_constraints(devices, placements, _make_lab(), checker)
assert cost > 0
assert not math.isinf(cost)
def test_collision_returns_inf_binary_mode(self):
"""Binary mode: 碰撞布局应返回 inf。"""
devices = _make_devices()
placements = [
Placement("a", 1.0, 1.0, 0.0),
Placement("b", 1.2, 1.0, 0.0),
]
checker = MockCollisionChecker()
cost = evaluate_default_hard_constraints(
devices, placements, _make_lab(), checker, graduated=False,
)
assert math.isinf(cost)
def test_out_of_bounds_returns_graduated_penalty(self):
"""越界布局应返回正的graduated penalty非inf"""
devices = _make_devices()
placements = [
Placement("a", 0.1, 0.1, 0.0), # 左下角越界
Placement("b", 3.0, 3.0, 0.0),
]
checker = MockCollisionChecker()
cost = evaluate_default_hard_constraints(devices, placements, _make_lab(), checker)
assert cost > 0
assert not math.isinf(cost)
def test_out_of_bounds_returns_inf_binary_mode(self):
"""Binary mode: 越界布局应返回 inf。"""
devices = _make_devices()
placements = [
Placement("a", 0.1, 0.1, 0.0),
Placement("b", 3.0, 3.0, 0.0),
]
checker = MockCollisionChecker()
cost = evaluate_default_hard_constraints(
devices, placements, _make_lab(), checker, graduated=False,
)
assert math.isinf(cost)
def test_worse_collision_higher_cost(self):
"""Deeper penetration should produce higher cost."""
devices = _make_devices()
checker = MockCollisionChecker()
lab = _make_lab()
# Small overlap
cost_small = evaluate_default_hard_constraints(
devices, [Placement("a", 1.0, 1.0, 0.0), Placement("b", 1.4, 1.0, 0.0)],
lab, checker,
)
# Large overlap
cost_large = evaluate_default_hard_constraints(
devices, [Placement("a", 1.0, 1.0, 0.0), Placement("b", 1.1, 1.0, 0.0)],
lab, checker,
)
assert cost_large > cost_small > 0
class TestUserConstraints:
def test_distance_less_than_satisfied(self):
"""距离约束满足时 cost=0。"""
devices = _make_devices()
placements = [
Placement("a", 1.0, 1.0, 0.0),
Placement("b", 1.5, 1.0, 0.0),
]
constraints = [
Constraint(type="hard", rule_name="distance_less_than",
params={"device_a": "a", "device_b": "b", "distance": 1.0})
]
checker = MockCollisionChecker()
reachability = MockReachabilityChecker()
cost = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker, reachability
)
assert cost == 0.0
def test_distance_less_than_violated_hard(self):
"""硬距离约束违反graduated模式返回有限惩罚binary模式返回inf。"""
devices = _make_devices()
placements = [
Placement("a", 1.0, 1.0, 0.0),
Placement("b", 4.0, 3.0, 0.0),
]
constraints = [
Constraint(type="hard", rule_name="distance_less_than",
params={"device_a": "a", "device_b": "b", "distance": 1.0})
]
checker = MockCollisionChecker()
# graduated=True (default): 有限惩罚
cost = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker
)
assert cost > 0
assert not math.isinf(cost)
# graduated=False: binary inf
cost_binary = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker,
graduated=False,
)
assert math.isinf(cost_binary)
def test_minimize_distance_cost(self):
"""minimize_distance 约束应返回正比于距离的 cost。"""
devices = _make_devices()
placements = [
Placement("a", 1.0, 1.0, 0.0),
Placement("b", 3.0, 1.0, 0.0),
]
constraints = [
Constraint(type="soft", rule_name="minimize_distance",
params={"device_a": "a", "device_b": "b"}, weight=2.0)
]
checker = MockCollisionChecker()
cost = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker
)
# edge-to-edge distance = 2.0 - 0.25 - 0.25 = 1.5, weight = 2.0 → cost = 3.0
assert abs(cost - 3.0) < 0.01
def test_reachability_constraint(self):
"""可达性约束:目标在臂展内应通过(不返回 inf
Opening-faces-arm penalty may add a small soft cost when the
target's opening doesn't face the arm, but it must not cause
hard failure (inf).
"""
devices = [
Device(id="arm", name="Arm", bbox=(0.2, 0.2), device_type="articulation"),
Device(id="target", name="Target", bbox=(0.5, 0.5)),
]
placements = [
Placement("arm", 1.0, 1.0, 0.0),
Placement("target", 1.5, 1.0, 0.0),
]
constraints = [
Constraint(type="hard", rule_name="reachability",
params={"arm_id": "arm", "target_device_id": "target"})
]
checker = MockCollisionChecker()
reachability = MockReachabilityChecker(arm_reach={"arm": 1.0})
cost = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker, reachability
)
assert not math.isinf(cost) # reachable → no hard failure
def test_reachability_constraint_violated(self):
"""可达性约束:目标超出臂展 — graduated返回有限惩罚binary返回inf。"""
devices = [
Device(id="arm", name="Arm", bbox=(0.2, 0.2), device_type="articulation"),
Device(id="target", name="Target", bbox=(0.5, 0.5)),
]
placements = [
Placement("arm", 1.0, 1.0, 0.0),
Placement("target", 4.0, 3.0, 0.0),
]
constraints = [
Constraint(type="hard", rule_name="reachability",
params={"arm_id": "arm", "target_device_id": "target"})
]
checker = MockCollisionChecker()
reachability = MockReachabilityChecker(arm_reach={"arm": 1.0})
# graduated=True (default): 有限惩罚
cost = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker, reachability
)
assert cost > 0
assert not math.isinf(cost)
# graduated=False: binary inf
cost_binary = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker, reachability,
graduated=False,
)
assert math.isinf(cost_binary)
def test_distance_less_than_uses_edge_to_edge():
"""distance_less_than should measure edge-to-edge, not center-to-center.
Two devices: centers 3m apart, each 2m wide → edge gap = 1m.
Constraint: distance_less_than 1.5m (edge-to-edge).
Old center-to-center: 3m > 1.5m → violation.
New edge-to-edge: 1m < 1.5m → satisfied.
"""
devices = [
Device(id="a", name="A", bbox=(2.0, 1.0)),
Device(id="b", name="B", bbox=(2.0, 1.0)),
]
placements = [
Placement(device_id="a", x=1.0, y=1.0, theta=0.0),
Placement(device_id="b", x=4.0, y=1.0, theta=0.0),
]
lab = Lab(width=10, depth=10)
constraint = Constraint(
type="soft", rule_name="distance_less_than",
params={"device_a": "a", "device_b": "b", "distance": 1.5},
weight=1.0,
)
checker = MockCollisionChecker()
cost = evaluate_constraints(devices, placements, lab, [constraint], checker)
assert cost == pytest.approx(0.0)
def test_prefer_aligned_zero_at_cardinal():
"""prefer_aligned cost = 0 when all devices at 0/90/180/270°."""
devices = [Device(id="a", name="A", bbox=(1.0, 1.0))]
lab = Lab(width=10, depth=10)
checker = MockCollisionChecker()
for angle in [0, math.pi / 2, math.pi, 3 * math.pi / 2]:
placements = [Placement(device_id="a", x=5, y=5, theta=angle)]
constraint = Constraint(type="soft", rule_name="prefer_aligned", weight=1.0)
cost = evaluate_constraints(devices, placements, lab, [constraint], checker)
assert cost == pytest.approx(0.0, abs=1e-9)
def test_prefer_aligned_max_at_45():
"""prefer_aligned cost is maximum when device at 45°."""
devices = [Device(id="a", name="A", bbox=(1.0, 1.0))]
placements = [Placement(device_id="a", x=5, y=5, theta=math.pi / 4)]
lab = Lab(width=10, depth=10)
constraint = Constraint(type="soft", rule_name="prefer_aligned", weight=1.0)
checker = MockCollisionChecker()
cost = evaluate_constraints(devices, placements, lab, [constraint], checker)
# (1 - cos(4 * pi/4)) / 2 = (1 - cos(pi)) / 2 = (1 - (-1)) / 2 = 1.0
assert cost == pytest.approx(1.0)
def test_prefer_aligned_sums_over_devices():
"""Cost sums across all devices."""
devices = [
Device(id="a", name="A", bbox=(1.0, 1.0)),
Device(id="b", name="B", bbox=(1.0, 1.0)),
]
placements = [
Placement(device_id="a", x=2, y=2, theta=math.pi / 4), # cost = 1.0
Placement(device_id="b", x=7, y=7, theta=math.pi / 4), # cost = 1.0
]
lab = Lab(width=10, depth=10)
constraint = Constraint(type="soft", rule_name="prefer_aligned", weight=2.0)
checker = MockCollisionChecker()
cost = evaluate_constraints(devices, placements, lab, [constraint], checker)
# 2 devices × 1.0 × weight 2.0 = 4.0
assert cost == pytest.approx(4.0)
class TestGraduatedHardConstraints:
"""graduated 模式下硬约束返回比例惩罚而非 inf。"""
def test_hard_reachability_graduated_finite(self):
"""graduated=True: 硬可达性返回有限惩罚。"""
devices = [
Device(id="arm", name="Arm", bbox=(0.2, 0.2), device_type="articulation"),
Device(id="t", name="Target", bbox=(0.5, 0.5)),
]
placements = [
Placement("arm", 1.0, 1.0, 0.0),
Placement("t", 4.0, 3.0, 0.0),
]
constraints = [
Constraint(type="hard", rule_name="reachability",
params={"arm_id": "arm", "target_device_id": "t"}, weight=1.0)
]
checker = MockCollisionChecker()
reach = MockReachabilityChecker(arm_reach={"arm": 1.0})
cost = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker, reach,
graduated=True,
)
assert cost > 0
assert not math.isinf(cost)
def test_hard_reachability_binary_inf(self):
"""graduated=False: 硬可达性返回 inf。"""
devices = [
Device(id="arm", name="Arm", bbox=(0.2, 0.2), device_type="articulation"),
Device(id="t", name="Target", bbox=(0.5, 0.5)),
]
placements = [
Placement("arm", 1.0, 1.0, 0.0),
Placement("t", 4.0, 3.0, 0.0),
]
constraints = [
Constraint(type="hard", rule_name="reachability",
params={"arm_id": "arm", "target_device_id": "t"}, weight=1.0)
]
checker = MockCollisionChecker()
reach = MockReachabilityChecker(arm_reach={"arm": 1.0})
cost = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker, reach,
graduated=False,
)
assert math.isinf(cost)
def test_hard_min_spacing_graduated_sums_all_pairs(self):
"""graduated模式min_spacing 对所有违规对求和(不只第一对)。"""
devices = [
Device(id="a", name="A", bbox=(0.5, 0.5)),
Device(id="b", name="B", bbox=(0.5, 0.5)),
Device(id="c", name="C", bbox=(0.5, 0.5)),
]
# 三个设备间距都小于 min_gap=1.0
placements = [
Placement("a", 1.0, 2.0, 0.0),
Placement("b", 1.3, 2.0, 0.0), # OBB 边缘距 a 约 0.3
Placement("c", 1.6, 2.0, 0.0), # OBB 边缘距 b 约 0.3, 距 a 约 0.6
]
constraints = [
Constraint(type="hard", rule_name="min_spacing",
params={"min_gap": 1.0}, weight=1.0)
]
checker = MockCollisionChecker()
cost = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker,
graduated=True,
)
# 应大于 0 且有限(累加多对违规)
assert cost > 0
assert not math.isinf(cost)
def test_hard_min_spacing_binary_inf(self):
"""graduated=False: min_spacing 违规返回 inf。"""
devices = _make_devices()
placements = [
Placement("a", 1.0, 2.0, 0.0),
Placement("b", 1.3, 2.0, 0.0),
]
constraints = [
Constraint(type="hard", rule_name="min_spacing",
params={"min_gap": 1.0}, weight=1.0)
]
checker = MockCollisionChecker()
cost = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker,
graduated=False,
)
assert math.isinf(cost)
def test_hard_distance_less_than_graduated(self):
"""graduated模式distance_less_than 硬约束返回比例惩罚。"""
devices = _make_devices()
placements = [
Placement("a", 1.0, 2.0, 0.0),
Placement("b", 4.0, 2.0, 0.0),
]
constraints = [
Constraint(type="hard", rule_name="distance_less_than",
params={"device_a": "a", "device_b": "b", "distance": 0.5},
weight=2.0)
]
checker = MockCollisionChecker()
cost = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker,
graduated=True,
)
# HARD_MULTIPLIER(5) × weight(2) × overshoot > 0
assert cost > 0
assert not math.isinf(cost)
def test_graduated_default_is_true(self):
"""不传 graduated 参数时默认使用 graduated 模式。"""
devices = _make_devices()
placements = [
Placement("a", 1.0, 2.0, 0.0),
Placement("b", 4.0, 2.0, 0.0),
]
constraints = [
Constraint(type="hard", rule_name="distance_less_than",
params={"device_a": "a", "device_b": "b", "distance": 0.5},
weight=1.0)
]
checker = MockCollisionChecker()
# 不指定 graduated — 默认应为 True → 有限惩罚
cost = evaluate_constraints(
devices, placements, _make_lab(), constraints, checker,
)
assert not math.isinf(cost)
class TestCrossingPenalty:
"""_crossing_penalty: 交叉长度加权的 soft penalty。"""
def _make_device(self, dev_id, bbox=(0.5, 0.5), direction=(0.0, -1.0)):
return Device(
id=dev_id, name=dev_id, device_type="static",
bbox=bbox, height=0.3,
openings=[Opening(direction=direction, label="front")],
)
def test_no_blockers_returns_zero(self):
"""arm 与 target 之间无遮挡设备 → 交叉代价为 0。"""
arm = self._make_device("arm", bbox=(2.14, 0.35))
target = self._make_device("target")
arm_p = Placement(device_id="arm", x=2.0, y=1.0, theta=0.0)
target_p = Placement(device_id="target", x=0.5, y=1.0, theta=3.14159)
device_map = {"arm": arm, "target": target}
placement_map = {"arm": arm_p, "target": target_p}
opening_pt = _opening_surface_center(target, target_p)
arm_corners = obb_corners(arm_p.x, arm_p.y, arm.bbox[0], arm.bbox[1], arm_p.theta)
nearest = nearest_point_on_obb(opening_pt[0], opening_pt[1], arm_corners)
cost = _crossing_penalty(
opening_pt, nearest,
"arm", "target",
device_map, placement_map,
)
assert cost == 0.0
def test_one_blocker_proportional_to_length(self):
"""一个遮挡设备 → cost = DEFAULT_WEIGHT_DISTANCE * 穿过长度。"""
arm = self._make_device("arm", bbox=(2.14, 0.35))
target = self._make_device("target")
blocker = self._make_device("blocker", bbox=(0.5, 0.5))
arm_p = Placement(device_id="arm", x=3.0, y=1.0, theta=0.0)
target_p = Placement(device_id="target", x=0.0, y=1.0, theta=0.0)
blocker_p = Placement(device_id="blocker", x=1.5, y=1.0, theta=0.0)
device_map = {"arm": arm, "target": target, "blocker": blocker}
placement_map = {"arm": arm_p, "target": target_p, "blocker": blocker_p}
opening_pt = _opening_surface_center(target, target_p)
arm_corners = obb_corners(arm_p.x, arm_p.y, arm.bbox[0], arm.bbox[1], arm_p.theta)
nearest = nearest_point_on_obb(opening_pt[0], opening_pt[1], arm_corners)
cost = _crossing_penalty(
opening_pt, nearest,
"arm", "target",
device_map, placement_map,
)
# blocker 宽 0.5mtheta=0路径水平 → 穿过长度 ≈ 0.5m
# cost = DEFAULT_WEIGHT_DISTANCE * 0.5 = 100 * 0.5 = 50
assert cost > 0
assert abs(cost - DEFAULT_WEIGHT_DISTANCE * 0.5) < DEFAULT_WEIGHT_DISTANCE * 0.1
def test_blocker_off_path_returns_zero(self):
"""不在路径上的设备 → 交叉代价为 0。"""
arm = self._make_device("arm", bbox=(2.14, 0.35))
target = self._make_device("target")
bystander = self._make_device("bystander", bbox=(0.5, 0.5))
arm_p = Placement(device_id="arm", x=3.0, y=1.0, theta=0.0)
target_p = Placement(device_id="target", x=0.0, y=1.0, theta=0.0)
bystander_p = Placement(device_id="bystander", x=1.5, y=3.0, theta=0.0)
device_map = {"arm": arm, "target": target, "bystander": bystander}
placement_map = {"arm": arm_p, "target": target_p, "bystander": bystander_p}
opening_pt = _opening_surface_center(target, target_p)
arm_corners = obb_corners(arm_p.x, arm_p.y, arm.bbox[0], arm.bbox[1], arm_p.theta)
nearest = nearest_point_on_obb(opening_pt[0], opening_pt[1], arm_corners)
cost = _crossing_penalty(
opening_pt, nearest,
"arm", "target",
device_map, placement_map,
)
assert cost == 0.0

View File

@@ -0,0 +1,234 @@
"""device_catalog 双源加载测试。"""
from __future__ import annotations
from pathlib import Path
import pytest
from ..device_catalog import (
_DEFAULT_FOOTPRINTS,
create_devices_from_list,
load_devices_from_assets,
load_devices_from_registry,
load_footprints,
merge_device_lists,
reset_footprints_cache,
resolve_device,
)
# ---------- fixtures ----------
# LeapLab/layout_optimizer/tests/ → LeapLab/ → DPTech/
_LEAPLAB = Path(__file__).resolve().parent.parent.parent
_DPTECH = _LEAPLAB.parent
DATA_JSON = _DPTECH / "uni-lab-assets" / "data.json"
REGISTRY_DIR = _LEAPLAB / "Uni-Lab-OS" / "unilabos" / "device_mesh" / "devices"
@pytest.fixture(autouse=True)
def _clear_cache():
"""每个测试前清除缓存。"""
reset_footprints_cache()
yield
reset_footprints_cache()
# ---------- footprints ----------
class TestLoadFootprints:
def test_load_footprints_exists(self):
fp = load_footprints(_DEFAULT_FOOTPRINTS)
assert isinstance(fp, dict)
assert len(fp) > 0
def test_footprint_structure(self):
fp = load_footprints()
for dev_id, entry in fp.items():
assert "bbox" in entry, f"{dev_id} missing bbox"
assert len(entry["bbox"]) == 2
assert "height" in entry
assert "origin_offset" in entry
assert "openings" in entry
def test_known_device_in_footprints(self):
fp = load_footprints()
assert "agilent_bravo" in fp
bbox = fp["agilent_bravo"]["bbox"]
assert 0.5 < bbox[0] < 1.0 # width ~0.65m
assert 0.5 < bbox[1] < 1.0 # depth ~0.70m
def test_nonexistent_path_returns_empty(self):
reset_footprints_cache()
fp = load_footprints("/nonexistent/footprints.json")
assert fp == {}
# ---------- assets 加载 ----------
class TestLoadFromAssets:
@pytest.mark.skipif(not DATA_JSON.exists(), reason="data.json not found")
def test_load_returns_devices(self):
devices = load_devices_from_assets(DATA_JSON)
assert len(devices) > 0
@pytest.mark.skipif(not DATA_JSON.exists(), reason="data.json not found")
def test_known_device_has_real_bbox(self):
devices = load_devices_from_assets(DATA_JSON)
bravo = next((d for d in devices if d.id == "agilent_bravo"), None)
assert bravo is not None
assert bravo.bbox != (0.6, 0.4) # 不是默认值
assert bravo.source == "assets"
def test_missing_data_json(self):
devices = load_devices_from_assets("/nonexistent/data.json")
assert devices == []
# ---------- registry 加载 ----------
class TestLoadFromRegistry:
@pytest.mark.skipif(not REGISTRY_DIR.exists(), reason="registry dir not found")
def test_load_returns_devices(self):
devices = load_devices_from_registry(REGISTRY_DIR)
assert len(devices) > 0
@pytest.mark.skipif(not REGISTRY_DIR.exists(), reason="registry dir not found")
def test_elite_robot_present(self):
devices = load_devices_from_registry(REGISTRY_DIR)
elite = next((d for d in devices if d.id == "elite_robot"), None)
assert elite is not None
assert elite.source == "registry"
def test_missing_dir(self):
devices = load_devices_from_registry("/nonexistent/")
assert devices == []
# ---------- 合并与去重 ----------
class TestMergeDedup:
def test_registry_wins_dedup(self):
from ..models import Device
reg = [Device(id="ot2", name="OT-2 Registry", bbox=(0.62, 0.50), source="registry")]
asset = [Device(id="ot2", name="OT-2 Assets", bbox=(0.62, 0.50), source="assets")]
merged = merge_device_lists(reg, asset)
ot2 = next(d for d in merged if d.id == "ot2")
assert ot2.source == "registry"
assert ot2.name == "OT-2 Registry"
def test_merge_preserves_unique(self):
from ..models import Device
reg = [Device(id="elite", name="Elite", source="registry")]
asset = [Device(id="bravo", name="Bravo", source="assets")]
merged = merge_device_lists(reg, asset)
ids = {d.id for d in merged}
assert ids == {"elite", "bravo"}
def test_registry_inherits_asset_model(self):
from ..models import Device
reg = [Device(id="ot2", name="OT-2", source="registry", model_path="")]
asset = [Device(id="ot2", name="OT-2", source="assets", model_path="/models/ot2/mesh.glb")]
merged = merge_device_lists(reg, asset)
ot2 = next(d for d in merged if d.id == "ot2")
assert ot2.model_path == "/models/ot2/mesh.glb"
# ---------- resolve_device ----------
class TestResolveDevice:
def test_known_device(self):
dev = resolve_device("agilent_bravo")
assert dev is not None
assert dev.id == "agilent_bravo"
assert dev.bbox != (0.6, 0.4)
def test_fallback_known_sizes(self):
dev = resolve_device("ot2")
assert dev is not None
assert dev.bbox == (0.62, 0.50)
def test_unknown_device_returns_none(self):
dev = resolve_device("totally_unknown_device_xyz")
assert dev is None
# ---------- create_devices_from_list (向后兼容) ----------
class TestCreateDevicesFromList:
def test_basic(self):
specs = [{"id": "test_dev", "name": "Test"}]
devs = create_devices_from_list(specs)
assert len(devs) == 1
assert devs[0].id == "test_dev"
def test_with_explicit_size(self):
specs = [{"id": "custom", "name": "Custom", "size": [1.0, 0.5]}]
devs = create_devices_from_list(specs)
assert devs[0].bbox == (1.0, 0.5)
def test_footprint_size_used_when_no_explicit(self):
specs = [{"id": "agilent_bravo", "name": "Bravo"}]
devs = create_devices_from_list(specs)
assert devs[0].bbox != (0.6, 0.4) # 使用 footprints 中的真实尺寸
def test_duplicate_catalog_ids_use_suffixes_and_store_uuid(self):
specs = [
{"id": "opentrons_liquid_handler", "uuid": "u1"},
{"id": "opentrons_liquid_handler", "uuid": "u2"},
]
devs = create_devices_from_list(specs)
assert [dev.id for dev in devs] == [
"opentrons_liquid_handler",
"opentrons_liquid_handler#2",
]
assert [dev.uuid for dev in devs] == ["u1", "u2"]
# ---------- server endpoint (需要 httpx) ----------
class TestDevicesEndpoint:
def test_get_devices(self):
try:
from fastapi.testclient import TestClient
except ImportError:
pytest.skip("fastapi testclient not available")
from ..server import app
client = TestClient(app)
resp = client.get("/devices")
assert resp.status_code == 200
data = resp.json()
assert isinstance(data, list)
# 可能为空(取决于 uni-lab-assets 是否在预期路径)
if len(data) > 0:
first = data[0]
assert "id" in first
assert "bbox" in first
assert "source" in first
def test_filter_by_source(self):
try:
from fastapi.testclient import TestClient
except ImportError:
pytest.skip("fastapi testclient not available")
from ..server import app
client = TestClient(app)
resp = client.get("/devices?source=registry")
assert resp.status_code == 200
data = resp.json()
for d in data:
assert d["source"] == "registry"

View File

@@ -0,0 +1,263 @@
"""End-to-end pipeline test: intents → interpret → optimize → verify.
Tests each stage boundary independently so failures are easy to localize.
Uses real PCR workflow devices with footprints from the catalog.
"""
import math
import pytest
from fastapi.testclient import TestClient
from ..server import app
client = TestClient(app)
# -- Scene: 5 PCR devices the user has already placed in the scene --
PCR_DEVICES = [
{"id": "thermo_orbitor_rs2_hotel", "name": "Plate Hotel", "device_type": "static"},
{"id": "arm_slider", "name": "Robot Arm", "device_type": "articulation"},
{"id": "opentrons_liquid_handler", "name": "Liquid Handler", "device_type": "static"},
{"id": "agilent_plateloc", "name": "Plate Sealer", "device_type": "static"},
{"id": "inheco_odtc_96xl", "name": "Thermal Cycler", "device_type": "static"},
]
PCR_LAB = {"width": 6.0, "depth": 4.0}
# -- Stage 1: simulated LLM output (what the LLM would produce from NL) --
# User said: "take plate from hotel, prepare sample in opentrons,
# seal plate then pcr cycle, arm_slider handles transfers"
LLM_INTENTS = [
{
"intent": "reachable_by",
"params": {
"arm": "arm_slider",
"targets": [
"thermo_orbitor_rs2_hotel",
"opentrons_liquid_handler",
"agilent_plateloc",
"inheco_odtc_96xl",
],
},
"description": "arm_slider must reach all workflow devices",
},
{
"intent": "workflow_hint",
"params": {
"workflow": "pcr",
"devices": [
"thermo_orbitor_rs2_hotel",
"opentrons_liquid_handler",
"agilent_plateloc",
"inheco_odtc_96xl",
],
},
"description": "PCR order: hotel → liquid handler → sealer → thermal cycler",
},
{
"intent": "close_together",
"params": {
"devices": ["opentrons_liquid_handler", "agilent_plateloc"],
"priority": "high",
},
"description": "Seal immediately after sample prep",
},
{
"intent": "min_spacing",
"params": {"min_gap": 0.15},
"description": "Minimum 15cm gap for accessibility",
},
]
class TestStage1Interpret:
"""Stage 1: /interpret translates intents → constraints."""
def test_interpret_returns_correct_constraint_count(self):
resp = client.post("/interpret", json={"intents": LLM_INTENTS})
assert resp.status_code == 200
data = resp.json()
# 4 reachability + 3 workflow minimize + 1 close minimize + 1 min_spacing = 9
assert len(data["constraints"]) == 9
assert len(data["errors"]) == 0
def test_interpret_has_translations_for_each_intent(self):
resp = client.post("/interpret", json={"intents": LLM_INTENTS})
data = resp.json()
assert len(data["translations"]) == len(LLM_INTENTS)
# 每个 translation 都有 explanation
for t in data["translations"]:
assert t["explanation"] != ""
def test_interpret_extracts_workflow_edges(self):
resp = client.post("/interpret", json={"intents": LLM_INTENTS})
data = resp.json()
assert len(data["workflow_edges"]) == 3
assert ["thermo_orbitor_rs2_hotel", "opentrons_liquid_handler"] in data["workflow_edges"]
assert ["opentrons_liquid_handler", "agilent_plateloc"] in data["workflow_edges"]
assert ["agilent_plateloc", "inheco_odtc_96xl"] in data["workflow_edges"]
def test_interpret_constraint_types_correct(self):
resp = client.post("/interpret", json={"intents": LLM_INTENTS})
data = resp.json()
constraints = data["constraints"]
by_rule = {}
for c in constraints:
by_rule.setdefault(c["rule_name"], []).append(c)
assert len(by_rule["reachability"]) == 4
assert all(c["type"] == "hard" for c in by_rule["reachability"])
assert len(by_rule["minimize_distance"]) == 4 # 3 workflow + 1 close
assert all(c["type"] == "soft" for c in by_rule["minimize_distance"])
assert len(by_rule["min_spacing"]) == 1
assert by_rule["min_spacing"][0]["type"] == "hard"
class TestStage2Optimize:
"""Stage 2: pipe /interpret output into /optimize → placements."""
@pytest.fixture()
def interpret_result(self):
resp = client.post("/interpret", json={"intents": LLM_INTENTS})
return resp.json()
def test_optimize_accepts_interpret_output(self, interpret_result):
"""Constraints + workflow_edges from /interpret are valid /optimize input."""
resp = client.post("/optimize", json={
"devices": PCR_DEVICES,
"lab": PCR_LAB,
"constraints": interpret_result["constraints"],
"workflow_edges": interpret_result["workflow_edges"],
"run_de": False, # seeder only — fast
})
assert resp.status_code == 200
data = resp.json()
assert len(data["placements"]) == 5
assert data["success"] is True
def test_optimize_with_de(self, interpret_result):
"""Full DE optimization completes without error."""
resp = client.post("/optimize", json={
"devices": PCR_DEVICES,
"lab": PCR_LAB,
"constraints": interpret_result["constraints"],
"workflow_edges": interpret_result["workflow_edges"],
"run_de": True,
"maxiter": 50, # reduced for test speed
"seed": 42,
})
assert resp.status_code == 200
data = resp.json()
assert len(data["placements"]) == 5
assert data["de_ran"] is True
class TestStage3VerifyPlacements:
"""Stage 3: verify optimized placements satisfy constraint intent."""
@pytest.fixture()
def placements(self):
# Full pipeline: interpret → optimize (with DE), all intents including reachability
# MockReachabilityChecker uses large fallback reach for unknown arms like arm_slider
interpret_resp = client.post("/interpret", json={"intents": LLM_INTENTS})
interpret_data = interpret_resp.json()
optimize_resp = client.post("/optimize", json={
"devices": PCR_DEVICES,
"lab": PCR_LAB,
"constraints": interpret_data["constraints"],
"workflow_edges": interpret_data["workflow_edges"],
"run_de": True,
"maxiter": 50,
"seed": 42,
})
return {p["device_id"]: p for p in optimize_resp.json()["placements"]}
def test_all_devices_placed(self, placements):
expected_ids = {d["id"] for d in PCR_DEVICES}
assert set(placements.keys()) == expected_ids
def test_all_within_lab_bounds(self, placements):
for dev_id, p in placements.items():
assert 0 <= p["position"]["x"] <= PCR_LAB["width"], f"{dev_id} x out of bounds"
assert 0 <= p["position"]["y"] <= PCR_LAB["depth"], f"{dev_id} y out of bounds"
def test_no_hard_constraint_violation(self):
"""Full pipeline with all intents including reachability converges cleanly.
MockReachabilityChecker now includes arm_slider in the default reach table
(1.07m). Binary final evaluation checks all hard constraints including
user-defined reachability.
"""
interpret_data = client.post("/interpret", json={"intents": LLM_INTENTS}).json()
optimize_resp = client.post("/optimize", json={
"devices": PCR_DEVICES,
"lab": PCR_LAB,
"constraints": interpret_data["constraints"],
"workflow_edges": interpret_data["workflow_edges"],
"run_de": True,
"maxiter": 100,
"seed": 42,
"snap_cardinal": True,
"seeder_overrides": {"align_weight": 60},
})
data = optimize_resp.json()
assert data["success"] is True
assert not math.isinf(data["cost"])
def test_workflow_neighbors_closer_than_diagonal(self, placements):
"""Workflow-adjacent devices should be closer than lab diagonal (basic sanity)."""
max_diagonal = math.sqrt(PCR_LAB["width"] ** 2 + PCR_LAB["depth"] ** 2)
workflow_pairs = [
("thermo_orbitor_rs2_hotel", "opentrons_liquid_handler"),
("opentrons_liquid_handler", "agilent_plateloc"),
("agilent_plateloc", "inheco_odtc_96xl"),
]
for a_id, b_id in workflow_pairs:
a, b = placements[a_id], placements[b_id]
dist = math.sqrt(
(a["position"]["x"] - b["position"]["x"]) ** 2
+ (a["position"]["y"] - b["position"]["y"]) ** 2
)
# 应该远小于对角线workflow minimize_distance 约束)
assert dist < max_diagonal * 0.8, (
f"Workflow pair {a_id}{b_id} distance {dist:.2f}m "
f"exceeds 80% of diagonal {max_diagonal:.2f}m"
)
class TestPipelineStageIsolation:
"""Verify each stage's output format is valid input for the next stage."""
def test_interpret_output_schema_matches_optimize_input(self):
"""constraints from /interpret have all fields /optimize expects."""
resp = client.post("/interpret", json={"intents": LLM_INTENTS})
data = resp.json()
for c in data["constraints"]:
assert "type" in c
assert "rule_name" in c
assert "params" in c
assert "weight" in c
assert c["type"] in ("hard", "soft")
for edge in data["workflow_edges"]:
assert isinstance(edge, list)
assert len(edge) == 2
def test_round_trip_no_data_loss(self):
"""Interpret → optimize → check that all device IDs survive the pipeline."""
interpret_resp = client.post("/interpret", json={"intents": LLM_INTENTS})
interpret_data = interpret_resp.json()
optimize_resp = client.post("/optimize", json={
"devices": PCR_DEVICES,
"lab": PCR_LAB,
"constraints": interpret_data["constraints"],
"workflow_edges": interpret_data["workflow_edges"],
"run_de": False,
})
result_ids = {p["device_id"] for p in optimize_resp.json()["placements"]}
input_ids = {d["id"] for d in PCR_DEVICES}
assert result_ids == input_ids

View File

@@ -0,0 +1,210 @@
"""Intent interpreter tests — PCR workflow devices."""
import pytest
from ..intent_interpreter import interpret_intents
from ..models import Intent
# --- reachable_by ---
def test_reachable_by_generates_hard_reachability():
intents = [Intent(
intent="reachable_by",
params={"arm": "arm_slider", "targets": ["opentrons_liquid_handler", "inheco_odtc_96xl"]},
description="Robot arm must reach liquid handler and thermal cycler",
)]
result = interpret_intents(intents)
assert len(result.constraints) == 2
assert all(c.rule_name == "reachability" for c in result.constraints)
assert all(c.type == "hard" for c in result.constraints)
assert result.constraints[0].params == {"arm_id": "arm_slider", "target_device_id": "opentrons_liquid_handler"}
assert result.constraints[1].params == {"arm_id": "arm_slider", "target_device_id": "inheco_odtc_96xl"}
assert len(result.translations) == 1
assert len(result.translations[0]["generated_constraints"]) == 2
def test_reachable_by_missing_arm():
result = interpret_intents([Intent(intent="reachable_by", params={"targets": ["a"]})])
assert len(result.constraints) == 0
assert len(result.errors) == 1
assert "arm" in result.errors[0].lower()
def test_reachable_by_empty_targets():
result = interpret_intents([Intent(intent="reachable_by", params={"arm": "arm_slider", "targets": []})])
assert len(result.constraints) == 0
assert len(result.errors) == 1
assert "targets" in result.errors[0].lower()
# --- close_together ---
def test_close_together_generates_minimize_distance():
intents = [Intent(intent="close_together", params={
"devices": ["opentrons_liquid_handler", "inheco_odtc_96xl", "agilent_plateloc"],
})]
result = interpret_intents(intents)
assert len(result.constraints) == 3 # C(3,2) = 3 pairs
assert all(c.rule_name == "minimize_distance" for c in result.constraints)
assert all(c.type == "soft" for c in result.constraints)
def test_close_together_priority_scales_weight():
low = interpret_intents([Intent(intent="close_together", params={"devices": ["a", "b"], "priority": "low"})])
high = interpret_intents([Intent(intent="close_together", params={"devices": ["a", "b"], "priority": "high"})])
assert high.constraints[0].weight > low.constraints[0].weight
assert high.constraints[0].weight == pytest.approx(16.0)
assert low.constraints[0].weight == pytest.approx(0.5)
def test_close_together_single_device_error():
result = interpret_intents([Intent(intent="close_together", params={"devices": ["a"]})])
assert len(result.errors) == 1
# --- far_apart ---
def test_far_apart_generates_maximize_distance():
result = interpret_intents([Intent(intent="far_apart", params={
"devices": ["inheco_odtc_96xl", "thermo_orbitor_rs2_hotel"],
})])
assert len(result.constraints) == 1
assert result.constraints[0].rule_name == "maximize_distance"
# --- max_distance / min_distance ---
def test_max_distance_generates_distance_less_than():
result = interpret_intents([Intent(intent="max_distance", params={
"device_a": "opentrons_liquid_handler", "device_b": "inheco_odtc_96xl", "distance": 1.5,
})])
assert len(result.constraints) == 1
c = result.constraints[0]
assert c.rule_name == "distance_less_than"
assert c.type == "hard"
assert c.params["distance"] == 1.5
def test_min_distance_generates_distance_greater_than():
result = interpret_intents([Intent(intent="min_distance", params={
"device_a": "inheco_odtc_96xl", "device_b": "thermo_orbitor_rs2_hotel", "distance": 2.0,
})])
c = result.constraints[0]
assert c.rule_name == "distance_greater_than"
assert c.type == "hard"
assert c.params["distance"] == 2.0
def test_max_distance_zero_is_valid():
"""distance=0 is falsy but valid — must not be rejected."""
result = interpret_intents([Intent(intent="max_distance", params={
"device_a": "a", "device_b": "b", "distance": 0,
})])
assert len(result.constraints) == 1
assert len(result.errors) == 0
def test_max_distance_missing_param():
result = interpret_intents([Intent(intent="max_distance", params={"device_a": "a"})])
assert len(result.errors) == 1
assert len(result.constraints) == 0
# --- orientation ---
def test_face_outward():
result = interpret_intents([Intent(intent="face_outward")])
assert result.constraints[0].rule_name == "prefer_orientation_mode"
assert result.constraints[0].params["mode"] == "outward"
def test_face_inward():
result = interpret_intents([Intent(intent="face_inward")])
assert result.constraints[0].params["mode"] == "inward"
def test_align_cardinal():
result = interpret_intents([Intent(intent="align_cardinal")])
assert result.constraints[0].rule_name == "prefer_aligned"
assert result.constraints[0].weight == pytest.approx(0.5)
def test_keep_adjacent_generates_minimize_distance():
result = interpret_intents([Intent(intent="keep_adjacent", params={
"devices": ["opentrons_liquid_handler", "agilent_plateloc"],
"priority": "high",
})])
assert len(result.constraints) == 1
assert result.constraints[0].rule_name == "minimize_distance"
assert result.constraints[0].weight == pytest.approx(16.0)
# --- min_spacing ---
def test_min_spacing():
result = interpret_intents([Intent(intent="min_spacing", params={"min_gap": 0.3})])
c = result.constraints[0]
assert c.rule_name == "min_spacing"
assert c.type == "hard"
assert c.params["min_gap"] == 0.3
# --- workflow_hint (PCR scenario) ---
def test_workflow_hint_pcr():
"""PCR workflow: pipette → thermal cycler → plate sealer → storage."""
intents = [Intent(
intent="workflow_hint",
params={
"workflow": "pcr",
"devices": [
"opentrons_liquid_handler",
"inheco_odtc_96xl",
"agilent_plateloc",
"thermo_orbitor_rs2_hotel",
],
},
)]
result = interpret_intents(intents)
assert len(result.constraints) == 3 # 4 devices → 3 consecutive pairs
assert all(c.rule_name == "minimize_distance" for c in result.constraints)
assert len(result.workflow_edges) == 3
assert ["opentrons_liquid_handler", "inheco_odtc_96xl"] in result.workflow_edges
assert result.translations[0]["confidence"] == "low"
def test_workflow_hint_single_device_error():
result = interpret_intents([Intent(intent="workflow_hint", params={"workflow": "test", "devices": ["a"]})])
assert len(result.errors) == 1
# --- unknown intent ---
def test_unknown_intent():
result = interpret_intents([Intent(intent="nonexistent")])
assert len(result.constraints) == 0
assert len(result.errors) == 1
assert "nonexistent" in result.errors[0]
# --- multi-intent combination ---
def test_full_pcr_scenario():
"""Arm reachability + close together for full PCR setup."""
intents = [
Intent(intent="reachable_by", params={
"arm": "arm_slider",
"targets": [
"opentrons_liquid_handler", "inheco_odtc_96xl",
"agilent_plateloc", "thermo_orbitor_rs2_hotel",
],
}),
Intent(intent="close_together", params={
"devices": ["opentrons_liquid_handler", "inheco_odtc_96xl"],
"priority": "high",
}),
]
result = interpret_intents(intents)
assert len(result.constraints) == 5 # 4 reachability + 1 minimize_distance
assert len(result.translations) == 2
assert len(result.errors) == 0

View File

@@ -0,0 +1,134 @@
"""Tests for /interpret and /interpret/schema API endpoints."""
import pytest
from fastapi.testclient import TestClient
from ..server import app
client = TestClient(app)
def test_interpret_reachable_by():
resp = client.post("/interpret", json={
"intents": [
{
"intent": "reachable_by",
"params": {
"arm": "arm_slider",
"targets": ["opentrons_liquid_handler", "inheco_odtc_96xl"],
},
"description": "Arm must reach liquid handler and thermal cycler",
}
]
})
assert resp.status_code == 200
data = resp.json()
assert len(data["constraints"]) == 2
assert all(c["rule_name"] == "reachability" for c in data["constraints"])
assert len(data["translations"]) == 1
assert data["translations"][0]["source_intent"] == "reachable_by"
assert len(data["errors"]) == 0
def test_interpret_pcr_workflow():
"""Full PCR: reachability + workflow_hint + close_together."""
resp = client.post("/interpret", json={
"intents": [
{
"intent": "reachable_by",
"params": {
"arm": "arm_slider",
"targets": [
"opentrons_liquid_handler",
"inheco_odtc_96xl",
"agilent_plateloc",
"thermo_orbitor_rs2_hotel",
],
},
},
{
"intent": "workflow_hint",
"params": {
"workflow": "pcr",
"devices": [
"opentrons_liquid_handler",
"inheco_odtc_96xl",
"agilent_plateloc",
"thermo_orbitor_rs2_hotel",
],
},
},
{
"intent": "close_together",
"params": {
"devices": ["opentrons_liquid_handler", "inheco_odtc_96xl"],
"priority": "high",
},
},
]
})
assert resp.status_code == 200
data = resp.json()
# 4 reachability + 3 workflow + 1 close = 8
assert len(data["constraints"]) == 8
assert len(data["workflow_edges"]) == 3
assert len(data["translations"]) == 3
assert len(data["errors"]) == 0
def test_interpret_returns_errors_for_bad_intents():
resp = client.post("/interpret", json={
"intents": [
{"intent": "reachable_by", "params": {}},
{"intent": "nonexistent_intent"},
]
})
assert resp.status_code == 200
data = resp.json()
assert len(data["errors"]) == 2
assert len(data["constraints"]) == 0
def test_interpret_empty_intents():
resp = client.post("/interpret", json={"intents": []})
assert resp.status_code == 200
data = resp.json()
assert data["constraints"] == []
assert data["translations"] == []
assert data["errors"] == []
def test_interpret_schema_returns_all_intents():
resp = client.get("/interpret/schema")
assert resp.status_code == 200
data = resp.json()
intents = data["intents"]
expected = {
"reachable_by", "close_together", "far_apart", "keep_adjacent",
"max_distance", "min_distance", "min_spacing",
"workflow_hint", "face_outward", "face_inward", "align_cardinal",
}
assert set(intents.keys()) == expected
def test_interpret_constraints_passable_to_optimize():
"""Constraints from /interpret should be directly usable in /optimize."""
# Step 1: interpret
interpret_resp = client.post("/interpret", json={
"intents": [
{"intent": "close_together", "params": {"devices": ["dev_a", "dev_b"]}},
]
})
constraints = interpret_resp.json()["constraints"]
# Step 2: pass to optimize (verify it accepts the format)
optimize_resp = client.post("/optimize", json={
"devices": [
{"id": "dev_a", "name": "Device A", "size": [0.5, 0.4]},
{"id": "dev_b", "name": "Device B", "size": [0.5, 0.4]},
],
"lab": {"width": 4.0, "depth": 3.0},
"constraints": constraints,
"run_de": False,
})
assert optimize_resp.status_code == 200
assert len(optimize_resp.json()["placements"]) == 2

View File

@@ -0,0 +1,277 @@
"""LLM 技能文档测试:用真实 LLM 验证模糊用户输入 → 结构化意图的翻译质量。
需要 ANTHROPIC_API_KEY 环境变量。无 key 时自动跳过。
测试覆盖设备名模糊匹配、工作流顺序推理、约束类型选择、JSON 格式正确性。
"""
import json
import os
import pytest
HAS_API_KEY = bool(os.environ.get("ANTHROPIC_API_KEY"))
pytestmark = pytest.mark.skipif(not HAS_API_KEY, reason="ANTHROPIC_API_KEY not set")
# 读取技能文档
_SKILL_DOC_PATH = os.path.join(
os.path.dirname(__file__), "..", "llm_skill", "layout_intent_translator.md"
)
# PCR 场景设备列表(模拟用户场景中已有的设备)
SCENE_DEVICE_LIST = """\
Devices in scene:
- thermo_orbitor_rs2_hotel: Thermo Orbitor RS2 Hotel (type: static, bbox: 0.68×0.52m)
- arm_slider: Arm Slider (type: articulation, bbox: 1.20×0.30m)
- opentrons_liquid_handler: Opentrons Liquid Handler (type: static, bbox: 0.65×0.60m)
- agilent_plateloc: Agilent PlateLoc (type: static, bbox: 0.35×0.40m)
- inheco_odtc_96xl: Inheco ODTC 96XL (type: static, bbox: 0.30×0.35m)
"""
VALID_DEVICE_IDS = {
"thermo_orbitor_rs2_hotel",
"arm_slider",
"opentrons_liquid_handler",
"agilent_plateloc",
"inheco_odtc_96xl",
}
VALID_INTENT_TYPES = {
"reachable_by", "close_together", "far_apart", "max_distance",
"min_distance", "min_spacing", "workflow_hint",
"face_outward", "face_inward", "align_cardinal",
}
def _call_llm(user_message: str) -> dict:
"""调用 LLM使用技能文档作为 system prompt返回解析后的 JSON。"""
import anthropic
with open(_SKILL_DOC_PATH) as f:
skill_doc = f.read()
client = anthropic.Anthropic()
response = client.messages.create(
model="claude-sonnet-4-20250514",
max_tokens=2000,
system=skill_doc,
messages=[
{"role": "user", "content": f"{SCENE_DEVICE_LIST}\n\n{user_message}"},
],
)
# 从 response 中提取 JSON
text = response.content[0].text
# LLM 可能返回 ```json ... ``` 包裹的 JSON
if "```json" in text:
text = text.split("```json")[1].split("```")[0]
elif "```" in text:
text = text.split("```")[1].split("```")[0]
return json.loads(text.strip())
def _extract_all_device_ids(intents: list[dict]) -> set[str]:
"""从意图列表中提取所有引用的设备 ID。"""
ids = set()
for intent in intents:
params = intent.get("params", {})
if "arm" in params:
ids.add(params["arm"])
for key in ("targets", "devices"):
if key in params:
ids.update(params[key])
for key in ("device_a", "device_b"):
if key in params:
ids.add(params[key])
return ids
class TestLLMFuzzyDeviceResolution:
"""测试 LLM 能否将模糊设备名映射到精确 ID。"""
def test_pcr_machine_resolves_to_inheco(self):
"""'PCR machine' 应解析为 inheco_odtc_96xl。"""
result = _call_llm(
"Keep the PCR machine close to the plate sealer"
)
intents = result["intents"]
all_ids = _extract_all_device_ids(intents)
assert "inheco_odtc_96xl" in all_ids, f"Expected inheco_odtc_96xl in {all_ids}"
assert "agilent_plateloc" in all_ids, f"Expected agilent_plateloc in {all_ids}"
def test_robot_resolves_to_articulation_type(self):
"""'the robot' / 'robot arm' 应解析为 arm_slider唯一 articulation 类型)。"""
result = _call_llm(
"The robot should be able to reach the liquid handler and the storage hotel"
)
intents = result["intents"]
all_ids = _extract_all_device_ids(intents)
assert "arm_slider" in all_ids, f"Expected arm_slider in {all_ids}"
assert "opentrons_liquid_handler" in all_ids
assert "thermo_orbitor_rs2_hotel" in all_ids
def test_all_resolved_ids_are_valid(self):
"""LLM 输出的所有设备 ID 必须来自场景设备列表。"""
result = _call_llm(
"Take plate from hotel, prepare sample in the pipetting robot, "
"seal it, then run thermal cycling. The arm handles all transfers."
)
intents = result["intents"]
all_ids = _extract_all_device_ids(intents)
invalid = all_ids - VALID_DEVICE_IDS
assert not invalid, f"LLM produced invalid device IDs: {invalid}"
class TestLLMWorkflowInterpretation:
"""测试 LLM 对工作流描述的理解和翻译。"""
def test_pcr_workflow_full(self):
"""完整 PCR 工作流描述应生成 reachable_by + workflow_hint + close_together。"""
result = _call_llm(
"I need to set up a PCR workflow: take plate from the hotel, "
"prepare the sample in the liquid handler, seal the plate, "
"then run the thermal cycler. The robot arm handles all plate transfers. "
"Keep the liquid handler and sealer close together."
)
intents = result["intents"]
intent_types = {i["intent"] for i in intents}
# 应包含核心意图类型
assert "reachable_by" in intent_types, f"Missing reachable_by in {intent_types}"
assert "workflow_hint" in intent_types, f"Missing workflow_hint in {intent_types}"
# reachable_by 应包含所有工作流设备作为 targets
reach_intents = [i for i in intents if i["intent"] == "reachable_by"]
assert len(reach_intents) >= 1
reach_targets = set()
for ri in reach_intents:
reach_targets.update(ri["params"].get("targets", []))
# 至少液体处理器和热循环仪应在可达范围内
assert "opentrons_liquid_handler" in reach_targets
assert "inheco_odtc_96xl" in reach_targets
def test_workflow_device_order(self):
"""workflow_hint 的设备顺序应反映工作流步骤。"""
result = _call_llm(
"PCR process: first the hotel dispenses a plate, then the opentrons "
"prepares the sample, next the plateloc seals it, finally the thermal "
"cycler runs PCR. Generate a workflow hint."
)
intents = result["intents"]
wf_intents = [i for i in intents if i["intent"] == "workflow_hint"]
assert len(wf_intents) >= 1, f"No workflow_hint found in {[i['intent'] for i in intents]}"
devices = wf_intents[0]["params"]["devices"]
# 验证顺序hotel → liquid_handler → plateloc → thermal_cycler
hotel_idx = devices.index("thermo_orbitor_rs2_hotel")
lh_idx = devices.index("opentrons_liquid_handler")
seal_idx = devices.index("agilent_plateloc")
tc_idx = devices.index("inheco_odtc_96xl")
assert hotel_idx < lh_idx < seal_idx < tc_idx, (
f"Wrong workflow order: {devices}"
)
class TestLLMOutputFormat:
"""测试 LLM 输出格式的正确性。"""
def test_output_has_intents_array(self):
"""输出必须有 intents 数组。"""
result = _call_llm("Keep all devices at least 30cm apart")
assert "intents" in result
assert isinstance(result["intents"], list)
assert len(result["intents"]) > 0
def test_each_intent_has_required_fields(self):
"""每个意图必须有 intent、params、description。"""
result = _call_llm(
"The robot arm should reach the liquid handler. "
"Keep the thermal cycler away from the plate hotel."
)
for intent in result["intents"]:
assert "intent" in intent, f"Missing 'intent' field: {intent}"
assert "params" in intent, f"Missing 'params' field: {intent}"
assert "description" in intent, f"Missing 'description' field: {intent}"
def test_intent_types_are_valid(self):
"""所有意图类型必须是已知类型。"""
result = _call_llm(
"Set up a compact PCR line: hotel → liquid handler → sealer → thermal cycler. "
"Robot arm handles transfers. Align everything neatly."
)
for intent in result["intents"]:
assert intent["intent"] in VALID_INTENT_TYPES, (
f"Unknown intent type: {intent['intent']}"
)
class TestLLMInterpretThenOptimize:
"""端到端LLM 翻译 → /interpret → /optimize → 验证布局。"""
def test_llm_output_accepted_by_interpret_endpoint(self):
"""LLM 输出应能直接被 /interpret 端点接受。"""
from fastapi.testclient import TestClient
from ..server import app
test_client = TestClient(app)
llm_result = _call_llm(
"Take plate from hotel, prepare sample in opentrons, "
"seal plate then pcr cycle, arm_slider handles all transfers. "
"Keep liquid handler and sealer close."
)
# /interpret 应接受 LLM 输出
resp = test_client.post("/interpret", json=llm_result)
assert resp.status_code == 200, f"Interpret failed: {resp.text}"
data = resp.json()
assert len(data["constraints"]) > 0, "No constraints generated"
assert len(data["errors"]) == 0, f"Interpretation errors: {data['errors']}"
def test_full_pipeline_llm_to_placement(self):
"""LLM 翻译 → interpret → optimize → 所有设备有 placement。"""
from fastapi.testclient import TestClient
from ..server import app
test_client = TestClient(app)
# Stage 1: LLM 翻译
llm_result = _call_llm(
"I want a PCR workflow lab. Take plate from the hotel, pipette in the "
"liquid handler, seal with the plateloc, then thermal cycle. "
"The robot arm does all transfers between devices. "
"Minimum 15cm gap between everything."
)
# Stage 2: interpret
interpret_resp = test_client.post("/interpret", json=llm_result)
assert interpret_resp.status_code == 200
interpret_data = interpret_resp.json()
assert len(interpret_data["errors"]) == 0
# Stage 3: optimize
pcr_devices = [
{"id": "thermo_orbitor_rs2_hotel", "name": "Plate Hotel", "device_type": "static"},
{"id": "arm_slider", "name": "Robot Arm", "device_type": "articulation"},
{"id": "opentrons_liquid_handler", "name": "Liquid Handler", "device_type": "static"},
{"id": "agilent_plateloc", "name": "Plate Sealer", "device_type": "static"},
{"id": "inheco_odtc_96xl", "name": "Thermal Cycler", "device_type": "static"},
]
optimize_resp = test_client.post("/optimize", json={
"devices": pcr_devices,
"lab": {"width": 6.0, "depth": 4.0},
"constraints": interpret_data["constraints"],
"workflow_edges": interpret_data.get("workflow_edges", []),
"run_de": True,
"maxiter": 50,
"seed": 42,
})
assert optimize_resp.status_code == 200
data = optimize_resp.json()
# Stage 4: 验证所有设备都有 placement
placed_ids = {p["device_id"] for p in data["placements"]}
expected_ids = {d["id"] for d in pcr_devices}
assert placed_ids == expected_ids
assert data["success"] is True

View File

@@ -0,0 +1,138 @@
"""MockCollisionChecker 和 MockReachabilityChecker 测试。"""
import math
from ..mock_checkers import MockCollisionChecker, MockReachabilityChecker
class TestMockCollisionChecker:
def setup_method(self):
self.checker = MockCollisionChecker()
def test_no_collision_far_apart(self):
"""两个设备距离足够远,不碰撞。"""
placements = [
{"id": "a", "bbox": (0.5, 0.5), "pos": (1.0, 1.0, 0.0)},
{"id": "b", "bbox": (0.5, 0.5), "pos": (3.0, 3.0, 0.0)},
]
assert self.checker.check(placements) == []
def test_collision_overlapping(self):
"""两个设备重叠,应检测到碰撞。"""
placements = [
{"id": "a", "bbox": (1.0, 1.0), "pos": (1.0, 1.0, 0.0)},
{"id": "b", "bbox": (1.0, 1.0), "pos": (1.5, 1.0, 0.0)},
]
collisions = self.checker.check(placements)
assert ("a", "b") in collisions
def test_collision_touching_edges(self):
"""两设备恰好边缘接触,不算碰撞(< 而非 <=)。"""
placements = [
{"id": "a", "bbox": (1.0, 1.0), "pos": (0.5, 0.5, 0.0)},
{"id": "b", "bbox": (1.0, 1.0), "pos": (1.5, 0.5, 0.0)},
]
collisions = self.checker.check(placements)
assert collisions == []
def test_collision_with_rotation(self):
"""旋转后的设备 OBB 可能导致碰撞。"""
placements = [
{"id": "a", "bbox": (1.0, 0.2), "pos": (1.0, 1.0, math.pi / 4)},
{"id": "b", "bbox": (0.5, 0.5), "pos": (1.4, 1.0, 0.0)}, # closer: OBB overlap
]
collisions = self.checker.check(placements)
assert ("a", "b") in collisions
def test_no_collision_with_rotation(self):
"""旋转后仍不碰撞。"""
placements = [
{"id": "a", "bbox": (1.0, 0.2), "pos": (1.0, 1.0, math.pi / 4)},
{"id": "b", "bbox": (0.5, 0.5), "pos": (2.0, 1.0, 0.0)},
]
collisions = self.checker.check(placements)
assert collisions == []
def test_check_bounds_within(self):
"""设备在边界内。"""
placements = [
{"id": "a", "bbox": (0.5, 0.5), "pos": (1.0, 1.0, 0.0)},
]
assert self.checker.check_bounds(placements, 5.0, 5.0) == []
def test_check_bounds_outside(self):
"""设备超出边界。"""
placements = [
{"id": "a", "bbox": (1.0, 1.0), "pos": (0.2, 0.2, 0.0)},
]
oob = self.checker.check_bounds(placements, 5.0, 5.0)
assert "a" in oob
def test_three_devices_multiple_collisions(self):
"""三个设备,两两碰撞。"""
placements = [
{"id": "a", "bbox": (1.0, 1.0), "pos": (1.0, 1.0, 0.0)},
{"id": "b", "bbox": (1.0, 1.0), "pos": (1.3, 1.0, 0.0)},
{"id": "c", "bbox": (1.0, 1.0), "pos": (1.6, 1.0, 0.0)},
]
collisions = self.checker.check(placements)
assert ("a", "b") in collisions
assert ("b", "c") in collisions
def test_obb_collision_rotated_no_false_positive():
"""A rotated narrow device should NOT collide with a nearby device
that the old AABB method would have flagged as colliding.
Old AABB expands footprint; OBB is precise.
"""
checker = MockCollisionChecker()
# Narrow device (2.0 x 0.5) rotated 45°:
# AABB would be ~1.77 x 1.77, OBB is the actual narrow rectangle
placements = [
{"id": "narrow", "bbox": (2.0, 0.5), "pos": (3.0, 3.0, math.pi / 4)},
{"id": "nearby", "bbox": (0.5, 0.5), "pos": (4.5, 3.0, 0.0)},
]
collisions = checker.check(placements)
# With OBB: no collision (the narrow rotated box doesn't reach)
assert ("narrow", "nearby") not in collisions and ("nearby", "narrow") not in collisions
class TestMockReachabilityChecker:
def setup_method(self):
self.checker = MockReachabilityChecker()
def test_reachable_within_radius(self):
"""目标在臂展半径内。"""
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
target = {"x": 0.5, "y": 0.5, "z": 0.0}
assert self.checker.is_reachable("elite_cs66", arm_pose, target)
def test_not_reachable_outside_radius(self):
"""目标超出臂展半径。"""
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
target = {"x": 2.0, "y": 2.0, "z": 0.0}
assert not self.checker.is_reachable("elite_cs66", arm_pose, target)
def test_reachable_at_boundary(self):
"""目标恰好在臂展边界上(应可达)。"""
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
target = {"x": 0.914, "y": 0.0, "z": 0.0}
assert self.checker.is_reachable("elite_cs66", arm_pose, target)
def test_unknown_arm_uses_default(self):
"""未知型号使用 1.0m 回退臂展realistic lab-scale default"""
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
# Within 1.0m fallback reach
target_near = {"x": 0.8, "y": 0.0, "z": 0.0}
assert self.checker.is_reachable("unknown_arm", arm_pose, target_near)
# Beyond 1.0m fallback reach
target_far = {"x": 1.5, "y": 0.0, "z": 0.0}
assert not self.checker.is_reachable("unknown_arm", arm_pose, target_far)
def test_custom_arm_reach(self):
"""自定义臂展参数。"""
checker = MockReachabilityChecker(arm_reach={"custom_arm": 1.5})
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
target = {"x": 1.4, "y": 0.0, "z": 0.0}
assert checker.is_reachable("custom_arm", arm_pose, target)

View File

@@ -0,0 +1,156 @@
"""Tests for OBB (Oriented Bounding Box) geometry utilities."""
import math
import pytest
from ..obb import obb_corners, obb_overlap, obb_min_distance, segment_obb_intersection_length
class TestObbCorners:
"""obb_corners(cx, cy, w, h, theta) → 4 corner points of the rotated rectangle."""
def test_no_rotation(self):
"""Axis-aligned box at origin: corners at ±half extents."""
corners = obb_corners(0, 0, 2.0, 1.0, 0.0)
assert len(corners) == 4
xs = sorted(c[0] for c in corners)
ys = sorted(c[1] for c in corners)
assert xs == pytest.approx([-1.0, -1.0, 1.0, 1.0])
assert ys == pytest.approx([-0.5, -0.5, 0.5, 0.5])
def test_90_degree_rotation(self):
"""90° rotation swaps width and height extents."""
corners = obb_corners(0, 0, 2.0, 1.0, math.pi / 2)
xs = sorted(c[0] for c in corners)
ys = sorted(c[1] for c in corners)
assert xs == pytest.approx([-0.5, -0.5, 0.5, 0.5])
assert ys == pytest.approx([-1.0, -1.0, 1.0, 1.0])
def test_offset_center(self):
"""Corners shift by (cx, cy)."""
corners = obb_corners(3.0, 2.0, 2.0, 1.0, 0.0)
xs = sorted(c[0] for c in corners)
ys = sorted(c[1] for c in corners)
assert xs == pytest.approx([2.0, 2.0, 4.0, 4.0])
assert ys == pytest.approx([1.5, 1.5, 2.5, 2.5])
def test_45_degree_rotation(self):
"""45° rotation: corners on diagonals."""
corners = obb_corners(0, 0, 2.0, 2.0, math.pi / 4)
for cx, cy in corners:
dist = math.sqrt(cx**2 + cy**2)
assert dist == pytest.approx(math.sqrt(2), abs=1e-9)
class TestObbOverlap:
"""obb_overlap(corners_a, corners_b) → True if the two OBBs overlap."""
def test_separated_boxes(self):
"""Two boxes far apart: no overlap."""
a = obb_corners(0, 0, 1.0, 1.0, 0.0)
b = obb_corners(5, 0, 1.0, 1.0, 0.0)
assert obb_overlap(a, b) is False
def test_overlapping_boxes(self):
"""Two boxes sharing space: overlap."""
a = obb_corners(0, 0, 2.0, 2.0, 0.0)
b = obb_corners(1, 0, 2.0, 2.0, 0.0)
assert obb_overlap(a, b) is True
def test_touching_edges_no_overlap(self):
"""Boxes touching at edge: no overlap (strict <, not <=)."""
a = obb_corners(0, 0, 2.0, 2.0, 0.0)
b = obb_corners(2.0, 0, 2.0, 2.0, 0.0)
assert obb_overlap(a, b) is False
def test_rotated_overlap(self):
"""One box rotated 45°, overlapping the other."""
a = obb_corners(0, 0, 2.0, 2.0, 0.0)
b = obb_corners(1.0, 1.0, 2.0, 2.0, math.pi / 4)
assert obb_overlap(a, b) is True
def test_rotated_no_overlap(self):
"""One box rotated 45°, separated from the other."""
a = obb_corners(0, 0, 1.0, 1.0, 0.0)
b = obb_corners(3, 0, 1.0, 1.0, math.pi / 4)
assert obb_overlap(a, b) is False
def test_identical_boxes(self):
"""Same position and size: overlap."""
a = obb_corners(1, 1, 1.0, 1.0, 0.0)
b = obb_corners(1, 1, 1.0, 1.0, 0.0)
assert obb_overlap(a, b) is True
class TestObbMinDistance:
"""obb_min_distance(corners_a, corners_b) → minimum edge-to-edge distance."""
def test_overlapping_returns_zero(self):
"""Overlapping boxes: distance = 0."""
a = obb_corners(0, 0, 2.0, 2.0, 0.0)
b = obb_corners(1, 0, 2.0, 2.0, 0.0)
assert obb_min_distance(a, b) == pytest.approx(0.0)
def test_separated_axis_aligned(self):
"""Two axis-aligned boxes with 2m gap."""
a = obb_corners(0, 0, 2.0, 2.0, 0.0) # edges at x=±1
b = obb_corners(4, 0, 2.0, 2.0, 0.0) # edges at x=3,5
# Gap = 3 - 1 = 2.0
assert obb_min_distance(a, b) == pytest.approx(2.0)
def test_diagonal_separation(self):
"""Boxes separated diagonally: distance to nearest corner."""
a = obb_corners(0, 0, 2.0, 2.0, 0.0) # corners at (±1, ±1)
b = obb_corners(4, 4, 2.0, 2.0, 0.0) # corners at (3..5, 3..5)
# Nearest corners: (1,1) to (3,3) → sqrt(8) ≈ 2.828
assert obb_min_distance(a, b) == pytest.approx(math.sqrt(8), abs=0.01)
def test_rotated_separation(self):
"""One rotated box separated from axis-aligned box."""
a = obb_corners(0, 0, 1.0, 1.0, 0.0)
b = obb_corners(3, 0, 1.0, 1.0, math.pi / 4)
dist = obb_min_distance(a, b)
assert dist > 0
def test_touching_returns_zero(self):
"""Touching edges: distance = 0."""
a = obb_corners(0, 0, 2.0, 2.0, 0.0)
b = obb_corners(2.0, 0, 2.0, 2.0, 0.0)
assert obb_min_distance(a, b) == pytest.approx(0.0)
class TestSegmentOBBIntersectionLength:
"""segment_obb_intersection_length: Cyrus-Beck clipping."""
def test_segment_fully_outside(self):
corners = obb_corners(0, 0, 2, 2, 0)
length = segment_obb_intersection_length((-5, 3), (5, 3), corners)
assert length == 0.0
def test_segment_fully_inside(self):
corners = obb_corners(0, 0, 4, 4, 0)
length = segment_obb_intersection_length((-0.5, 0), (0.5, 0), corners)
assert abs(length - 1.0) < 1e-6
def test_segment_crosses_through(self):
corners = obb_corners(0, 0, 2, 2, 0)
length = segment_obb_intersection_length((-5, 0), (5, 0), corners)
assert abs(length - 2.0) < 1e-6
def test_segment_partial_overlap(self):
corners = obb_corners(0, 0, 2, 2, 0)
length = segment_obb_intersection_length((0, 0), (5, 0), corners)
assert abs(length - 1.0) < 1e-6
def test_rotated_obb(self):
corners = obb_corners(0, 0, 2, 2, math.pi / 4)
length = segment_obb_intersection_length((-3, 0), (3, 0), corners)
expected = 2 * math.sqrt(2)
assert abs(length - expected) < 1e-4
def test_zero_length_segment(self):
corners = obb_corners(0, 0, 2, 2, 0)
assert segment_obb_intersection_length((0, 0), (0, 0), corners) == 0.0
def test_parallel_outside(self):
corners = obb_corners(0, 0, 2, 2, 0)
length = segment_obb_intersection_length((-5, 2), (5, 2), corners)
assert length == 0.0

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,430 @@
"""MoveItCollisionChecker 和 IKFastReachabilityChecker 测试。
使用 unittest.mock 模拟 MoveIt2 实例,验证适配器逻辑,
无需 ROS2 / MoveIt2 运行环境。
"""
import math
import tempfile
from pathlib import Path
from unittest.mock import MagicMock, patch
import numpy as np
import pytest
from ..ros_checkers import (
IKFastReachabilityChecker,
MoveItCollisionChecker,
_transform_to_arm_frame,
_yaw_to_quat,
_yaw_to_rotation_matrix,
create_checkers,
)
# ---------- 辅助函数测试 ----------
class TestYawToQuat:
def test_zero_rotation(self):
"""零旋转 → 单位四元数。"""
q = _yaw_to_quat(0.0)
assert q == pytest.approx((0.0, 0.0, 0.0, 1.0))
def test_90_degrees(self):
"""90° → (0, 0, sin(π/4), cos(π/4))。"""
q = _yaw_to_quat(math.pi / 2)
expected = (0.0, 0.0, math.sin(math.pi / 4), math.cos(math.pi / 4))
assert q == pytest.approx(expected)
def test_180_degrees(self):
"""180° → (0, 0, 1, 0)。"""
q = _yaw_to_quat(math.pi)
assert q == pytest.approx((0.0, 0.0, 1.0, 0.0), abs=1e-10)
class TestTransformToArmFrame:
def test_identity_transform(self):
"""臂在原点无旋转,目标在 (1, 0, 0.5)。"""
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
target = {"x": 1.0, "y": 0.0, "z": 0.5}
local = _transform_to_arm_frame(arm_pose, target)
assert local == pytest.approx((1.0, 0.0, 0.5))
def test_translation_only(self):
"""臂在 (2, 3) 无旋转,目标在 (3, 4, 0)。"""
arm_pose = {"x": 2.0, "y": 3.0, "theta": 0.0}
target = {"x": 3.0, "y": 4.0, "z": 0.0}
local = _transform_to_arm_frame(arm_pose, target)
assert local == pytest.approx((1.0, 1.0, 0.0))
def test_rotation_90(self):
"""臂旋转 90°目标在臂前方。"""
arm_pose = {"x": 0.0, "y": 0.0, "theta": math.pi / 2}
target = {"x": 0.0, "y": 1.0, "z": 0.0}
local = _transform_to_arm_frame(arm_pose, target)
# 世界 Y+ 在臂坐标系中变成 X+
assert local[0] == pytest.approx(1.0, abs=1e-10)
assert local[1] == pytest.approx(0.0, abs=1e-10)
class TestYawToRotationMatrix:
def test_identity(self):
"""零旋转 → 单位矩阵。"""
R = _yaw_to_rotation_matrix(0.0)
np.testing.assert_allclose(R, np.eye(3), atol=1e-10)
def test_90_degrees(self):
"""90° 旋转矩阵。"""
R = _yaw_to_rotation_matrix(math.pi / 2)
expected = np.array([
[0.0, -1.0, 0.0],
[1.0, 0.0, 0.0],
[0.0, 0.0, 1.0],
])
np.testing.assert_allclose(R, expected, atol=1e-10)
# ---------- MoveItCollisionChecker 测试 ----------
class TestMoveItCollisionChecker:
def setup_method(self):
self.moveit2 = MagicMock()
# 禁用 FCL使用 OBB 回退(测试环境无需 python-fcl
self.checker = MoveItCollisionChecker(
self.moveit2, sync_to_scene=True,
)
self.checker._fcl_available = False
def test_no_collision_far_apart(self):
"""两个设备距离足够远,不碰撞。"""
placements = [
{"id": "a", "bbox": (0.5, 0.5), "pos": (1.0, 1.0, 0.0)},
{"id": "b", "bbox": (0.5, 0.5), "pos": (3.0, 3.0, 0.0)},
]
assert self.checker.check(placements) == []
def test_collision_overlapping(self):
"""两个设备重叠,应检测到碰撞。"""
placements = [
{"id": "a", "bbox": (1.0, 1.0), "pos": (1.0, 1.0, 0.0)},
{"id": "b", "bbox": (1.0, 1.0), "pos": (1.5, 1.0, 0.0)},
]
collisions = self.checker.check(placements)
assert ("a", "b") in collisions
def test_collision_with_rotation(self):
"""旋转后的碰撞检测。"""
placements = [
{"id": "a", "bbox": (1.0, 0.2), "pos": (1.0, 1.0, math.pi / 4)},
{"id": "b", "bbox": (0.5, 0.5), "pos": (1.4, 1.0, 0.0)},
]
collisions = self.checker.check(placements)
assert ("a", "b") in collisions
def test_syncs_collision_objects(self):
"""验证 check() 调用 add_collision_box 同步到 MoveIt2。"""
placements = [
{"id": "dev_a", "bbox": (0.6, 0.8), "pos": (1.0, 2.0, 0.5)},
]
self.checker.check(placements)
self.moveit2.add_collision_box.assert_called_once()
call_kwargs = self.moveit2.add_collision_box.call_args
# 验证使用 {device_id}_ 前缀
assert call_kwargs.kwargs["id"] == "dev_a_"
# 验证 size = (w, d, h)
assert call_kwargs.kwargs["size"] == (0.6, 0.8, 0.4)
def test_device_id_prefix(self):
"""碰撞对象名称使用 {device_id}_ 前缀。"""
placements = [
{"id": "robot_arm", "bbox": (0.3, 0.3), "pos": (1.0, 1.0, 0.0)},
{"id": "centrifuge", "bbox": (0.5, 0.5), "pos": (3.0, 3.0, 0.0)},
]
self.checker.check(placements)
calls = self.moveit2.add_collision_box.call_args_list
ids = [c.kwargs["id"] for c in calls]
assert "robot_arm_" in ids
assert "centrifuge_" in ids
def test_sync_failure_does_not_crash(self):
"""add_collision_box 异常不影响碰撞检测结果。"""
self.moveit2.add_collision_box.side_effect = RuntimeError("service unavailable")
placements = [
{"id": "a", "bbox": (0.5, 0.5), "pos": (1.0, 1.0, 0.0)},
{"id": "b", "bbox": (0.5, 0.5), "pos": (3.0, 3.0, 0.0)},
]
# 不应抛异常
collisions = self.checker.check(placements)
assert collisions == []
def test_check_bounds_within(self):
"""设备在边界内。"""
placements = [
{"id": "a", "bbox": (0.5, 0.5), "pos": (1.0, 1.0, 0.0)},
]
assert self.checker.check_bounds(placements, 5.0, 5.0) == []
def test_check_bounds_outside(self):
"""设备超出边界。"""
placements = [
{"id": "a", "bbox": (1.0, 1.0), "pos": (0.2, 0.2, 0.0)},
]
oob = self.checker.check_bounds(placements, 5.0, 5.0)
assert "a" in oob
def test_no_sync_mode(self):
"""sync_to_scene=False 时不调用 add_collision_box。"""
checker = MoveItCollisionChecker(
self.moveit2, sync_to_scene=False,
)
checker._fcl_available = False
placements = [
{"id": "a", "bbox": (0.5, 0.5), "pos": (1.0, 1.0, 0.0)},
]
checker.check(placements)
self.moveit2.add_collision_box.assert_not_called()
def test_touching_edges_no_collision(self):
"""恰好边缘接触,不算碰撞。"""
placements = [
{"id": "a", "bbox": (1.0, 1.0), "pos": (0.5, 0.5, 0.0)},
{"id": "b", "bbox": (1.0, 1.0), "pos": (1.5, 0.5, 0.0)},
]
collisions = self.checker.check(placements)
assert collisions == []
def test_three_devices_multiple_collisions(self):
"""三个设备,相邻碰撞。"""
placements = [
{"id": "a", "bbox": (1.0, 1.0), "pos": (1.0, 1.0, 0.0)},
{"id": "b", "bbox": (1.0, 1.0), "pos": (1.3, 1.0, 0.0)},
{"id": "c", "bbox": (1.0, 1.0), "pos": (1.6, 1.0, 0.0)},
]
collisions = self.checker.check(placements)
assert ("a", "b") in collisions
assert ("b", "c") in collisions
# ---------- IKFastReachabilityChecker 测试 ----------
class TestIKFastReachabilityCheckerVoxel:
"""体素图模式测试。"""
def _create_voxel_dir(self, tmp_path: Path, arm_id: str = "elite_cs66") -> Path:
"""创建包含体素图的临时目录。"""
# 创建一个简单的体素网格:中心区域可达
grid = np.zeros((100, 100, 50), dtype=bool)
# 标记中心 60x60x30 区域为可达
grid[20:80, 20:80, 10:40] = True
origin = np.array([-0.5, -0.5, 0.0])
resolution = 0.01
npz_path = tmp_path / f"{arm_id}.npz"
np.savez(str(npz_path), grid=grid, origin=origin, resolution=resolution)
return tmp_path
def test_reachable_in_voxel(self, tmp_path):
"""目标在体素图可达区域内。"""
voxel_dir = self._create_voxel_dir(tmp_path)
checker = IKFastReachabilityChecker(voxel_dir=voxel_dir)
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
# 中心区域local = (0.0, 0.0, 0.2) → ix=50, iy=50, iz=20 → 可达
target = {"x": 0.0, "y": 0.0, "z": 0.2}
assert checker.is_reachable("elite_cs66", arm_pose, target)
def test_not_reachable_outside_voxel(self, tmp_path):
"""目标在体素图不可达区域。"""
voxel_dir = self._create_voxel_dir(tmp_path)
checker = IKFastReachabilityChecker(voxel_dir=voxel_dir)
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
# 边缘区域local = (-0.45, -0.45, 0.0) → ix=5, iy=5, iz=0 → 不可达
target = {"x": -0.45, "y": -0.45, "z": 0.0}
assert not checker.is_reachable("elite_cs66", arm_pose, target)
def test_out_of_bounds_not_reachable(self, tmp_path):
"""目标超出体素图范围。"""
voxel_dir = self._create_voxel_dir(tmp_path)
checker = IKFastReachabilityChecker(voxel_dir=voxel_dir)
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
target = {"x": 5.0, "y": 5.0, "z": 0.0}
assert not checker.is_reachable("elite_cs66", arm_pose, target)
def test_arm_rotation_transforms_target(self, tmp_path):
"""臂旋转后目标变换到臂坐标系。"""
voxel_dir = self._create_voxel_dir(tmp_path)
checker = IKFastReachabilityChecker(voxel_dir=voxel_dir)
# 臂旋转 90°目标在世界 Y+ 方向 → 臂坐标系 X+ 方向
arm_pose = {"x": 0.0, "y": 0.0, "theta": math.pi / 2}
# 世界 (0, 0.1, 0.2) → 臂坐标系 (0.1, 0, 0.2) → 在可达范围
target = {"x": 0.0, "y": 0.1, "z": 0.2}
assert checker.is_reachable("elite_cs66", arm_pose, target)
def test_unknown_arm_no_voxel_no_moveit(self, tmp_path):
"""未知臂型且无 MoveIt2乐观返回 True。"""
voxel_dir = self._create_voxel_dir(tmp_path)
checker = IKFastReachabilityChecker(voxel_dir=voxel_dir)
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
target = {"x": 0.5, "y": 0.0, "z": 0.0}
assert checker.is_reachable("unknown_arm", arm_pose, target)
def test_missing_voxel_dir(self):
"""体素目录不存在不报错。"""
checker = IKFastReachabilityChecker(voxel_dir="/nonexistent/path")
assert len(checker._voxel_maps) == 0
class TestIKFastReachabilityCheckerLiveIK:
"""实时 IK 模式测试。"""
def test_reachable_via_ik(self):
"""compute_ik 返回 JointState → 可达。"""
moveit2 = MagicMock()
moveit2.compute_ik.return_value = MagicMock() # 非 None → 成功
checker = IKFastReachabilityChecker(moveit2)
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
target = {"x": 0.5, "y": 0.0, "z": 0.3}
assert checker.is_reachable("elite_cs66", arm_pose, target)
def test_not_reachable_via_ik(self):
"""compute_ik 返回 None → 不可达。"""
moveit2 = MagicMock()
moveit2.compute_ik.return_value = None
checker = IKFastReachabilityChecker(moveit2)
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
target = {"x": 5.0, "y": 5.0, "z": 0.0}
assert not checker.is_reachable("elite_cs66", arm_pose, target)
def test_ik_exception_returns_false(self):
"""compute_ik 抛异常 → 不可达。"""
moveit2 = MagicMock()
moveit2.compute_ik.side_effect = RuntimeError("service timeout")
checker = IKFastReachabilityChecker(moveit2)
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
target = {"x": 0.5, "y": 0.0, "z": 0.0}
assert not checker.is_reachable("elite_cs66", arm_pose, target)
def test_ik_called_with_correct_position(self):
"""验证 compute_ik 接收正确的臂坐标系位置。"""
moveit2 = MagicMock()
moveit2.compute_ik.return_value = MagicMock()
checker = IKFastReachabilityChecker(moveit2)
arm_pose = {"x": 1.0, "y": 2.0, "theta": 0.0}
target = {"x": 1.5, "y": 2.3, "z": 0.4}
checker.is_reachable("elite_cs66", arm_pose, target)
call_kwargs = moveit2.compute_ik.call_args.kwargs
assert call_kwargs["position"] == pytest.approx((0.5, 0.3, 0.4))
def test_voxel_takes_priority_over_live_ik(self, tmp_path):
"""有体素图时优先使用体素查询,不调用 compute_ik。"""
# 创建体素图
grid = np.ones((10, 10, 10), dtype=bool)
origin = np.array([-0.05, -0.05, 0.0])
np.savez(
str(tmp_path / "test_arm.npz"),
grid=grid, origin=origin, resolution=0.01,
)
moveit2 = MagicMock()
checker = IKFastReachabilityChecker(moveit2, voxel_dir=tmp_path)
arm_pose = {"x": 0.0, "y": 0.0, "theta": 0.0}
target = {"x": 0.0, "y": 0.0, "z": 0.05}
checker.is_reachable("test_arm", arm_pose, target)
moveit2.compute_ik.assert_not_called()
# ---------- create_checkers 工厂函数测试 ----------
class TestCreateCheckers:
def test_mock_mode(self):
"""mock 模式返回 Mock 检测器。"""
from ..mock_checkers import (
MockCollisionChecker,
MockReachabilityChecker,
)
collision, reachability = create_checkers(mode="mock")
assert isinstance(collision, MockCollisionChecker)
assert isinstance(reachability, MockReachabilityChecker)
def test_moveit_mode(self):
"""moveit 模式返回 MoveIt2 检测器。"""
moveit2 = MagicMock()
collision, reachability = create_checkers(moveit2, mode="moveit")
assert isinstance(collision, MoveItCollisionChecker)
assert isinstance(reachability, IKFastReachabilityChecker)
def test_moveit_mode_requires_instance(self):
"""moveit 模式无实例时抛异常。"""
with pytest.raises(ValueError, match="MoveIt2 instance required"):
create_checkers(mode="moveit")
def test_default_mode_is_mock(self):
"""默认使用 mock 模式。"""
from ..mock_checkers import MockCollisionChecker
collision, _ = create_checkers()
assert isinstance(collision, MockCollisionChecker)
def test_env_var_override(self, monkeypatch):
"""LAYOUT_CHECKER_MODE 环境变量覆盖默认值。"""
moveit2 = MagicMock()
monkeypatch.setenv("LAYOUT_CHECKER_MODE", "moveit")
collision, _ = create_checkers(moveit2)
assert isinstance(collision, MoveItCollisionChecker)
# ---------- Protocol 兼容性测试 ----------
class TestProtocolConformance:
"""验证适配器满足 Protocol 接口签名。"""
def test_collision_checker_has_check(self):
"""MoveItCollisionChecker 实现 check(placements) 方法。"""
moveit2 = MagicMock()
checker = MoveItCollisionChecker(moveit2, sync_to_scene=False)
checker._fcl_available = False
placements = [
{"id": "a", "bbox": (0.5, 0.5), "pos": (1.0, 1.0, 0.0)},
]
result = checker.check(placements)
assert isinstance(result, list)
def test_reachability_checker_has_is_reachable(self):
"""IKFastReachabilityChecker 实现 is_reachable(arm_id, arm_pose, target) 方法。"""
checker = IKFastReachabilityChecker()
result = checker.is_reachable(
"arm_id",
{"x": 0.0, "y": 0.0, "theta": 0.0},
{"x": 0.5, "y": 0.0, "z": 0.0},
)
assert isinstance(result, bool)
def test_collision_checker_has_check_bounds(self):
"""MoveItCollisionChecker 实现 check_bounds 方法。"""
moveit2 = MagicMock()
checker = MoveItCollisionChecker(moveit2, sync_to_scene=False)
placements = [
{"id": "a", "bbox": (0.5, 0.5), "pos": (1.0, 1.0, 0.0)},
]
result = checker.check_bounds(placements, 5.0, 5.0)
assert isinstance(result, list)

View File

@@ -0,0 +1,113 @@
"""Tests for the force-directed seeder engine."""
import math
import pytest
from ..seeders import SeederParams, PRESETS, seed_layout
from ..models import Device, Lab, Placement
class TestSeederParams:
def test_presets_exist(self):
assert "compact_outward" in PRESETS
assert "spread_inward" in PRESETS
assert "row_fallback" in PRESETS
def test_compact_has_negative_boundary(self):
assert PRESETS["compact_outward"].boundary_attraction < 0
def test_spread_has_positive_boundary(self):
assert PRESETS["spread_inward"].boundary_attraction > 0
class TestSeedLayout:
"""seed_layout must return valid placements: within bounds, one per device."""
def _make_devices(self, n: int) -> list[Device]:
return [Device(id=f"d{i}", name=f"Device {i}", bbox=(0.6, 0.4)) for i in range(n)]
def test_returns_one_placement_per_device(self):
devices = self._make_devices(5)
lab = Lab(width=5.0, depth=4.0)
result = seed_layout(devices, lab, PRESETS["compact_outward"])
assert len(result) == 5
ids = {p.device_id for p in result}
assert ids == {f"d{i}" for i in range(5)}
def test_placements_within_bounds(self):
devices = self._make_devices(5)
lab = Lab(width=5.0, depth=4.0)
for preset_name in ["compact_outward", "spread_inward"]:
result = seed_layout(devices, lab, PRESETS[preset_name])
for p in result:
assert 0 <= p.x <= lab.width, f"{preset_name}: x={p.x} out of bounds"
assert 0 <= p.y <= lab.depth, f"{preset_name}: y={p.y} out of bounds"
def test_empty_devices(self):
result = seed_layout([], Lab(width=5, depth=4), PRESETS["compact_outward"])
assert result == []
def test_single_device(self):
devices = self._make_devices(1)
lab = Lab(width=5.0, depth=4.0)
result = seed_layout(devices, lab, PRESETS["compact_outward"])
assert len(result) == 1
assert 0 <= result[0].x <= lab.width
assert 0 <= result[0].y <= lab.depth
def test_row_fallback_delegates(self):
"""row_fallback preset uses generate_fallback, not force engine."""
devices = self._make_devices(3)
lab = Lab(width=5.0, depth=4.0)
# row_fallback is None in PRESETS; seed_layout detects and delegates
result = seed_layout(devices, lab, None) # None = row_fallback
assert len(result) == 3
def test_lab_too_small_returns_results_not_crash(self):
"""When space is insufficient, seeder still returns placements (may have collisions)."""
devices = [Device(id=f"d{i}", name=f"D{i}", bbox=(1.0, 1.0)) for i in range(20)]
lab = Lab(width=2.0, depth=2.0) # Way too small for 20 1m×1m devices
result = seed_layout(devices, lab, PRESETS["compact_outward"])
assert len(result) == 20 # All placed, even if overlapping
for p in result:
assert 0 <= p.x <= lab.width
assert 0 <= p.y <= lab.depth
def test_compact_clusters_toward_center(self):
"""compact_outward should place devices closer to center than spread_inward."""
devices = self._make_devices(4)
lab = Lab(width=8.0, depth=8.0)
center_x, center_y = lab.width / 2, lab.depth / 2
compact = seed_layout(devices, lab, PRESETS["compact_outward"])
spread = seed_layout(devices, lab, PRESETS["spread_inward"])
avg_dist_compact = sum(
math.sqrt((p.x - center_x)**2 + (p.y - center_y)**2) for p in compact
) / len(compact)
avg_dist_spread = sum(
math.sqrt((p.x - center_x)**2 + (p.y - center_y)**2) for p in spread
) / len(spread)
assert avg_dist_compact < avg_dist_spread
class TestOrientation:
"""Orientation modes should set theta based on position relative to center."""
def test_outward_orientation_sets_theta(self):
"""compact_outward: devices should have non-zero theta."""
devices = [
Device(id="a", name="A", bbox=(0.6, 0.4)),
Device(id="b", name="B", bbox=(0.6, 0.4)),
]
lab = Lab(width=5.0, depth=4.0)
result = seed_layout(devices, lab, PRESETS["compact_outward"])
thetas = [p.theta for p in result]
assert any(t != 0.0 for t in thetas) or len(devices) == 1
def test_none_orientation_keeps_zero(self):
"""orientation_mode='none': all thetas stay 0."""
devices = [Device(id="a", name="A", bbox=(0.6, 0.4))]
lab = Lab(width=5.0, depth=4.0)
params = SeederParams(boundary_attraction=0.0, orientation_mode="none")
result = seed_layout(devices, lab, params)
assert result[0].theta == 0.0

File diff suppressed because it is too large Load Diff

View File

@@ -1,589 +0,0 @@
workstation.bioyond_dispensing_station:
category:
- workstation
- bioyond
class:
action_value_mappings:
auto-batch_create_90_10_vial_feeding_tasks:
feedback: {}
goal: {}
goal_default:
delay_time: null
hold_m_name: null
liquid_material_name: NMP
speed: null
temperature: null
titration: null
handles: {}
placeholder_keys: {}
result: {}
schema:
description: ''
properties:
feedback: {}
goal:
properties:
delay_time:
type: string
hold_m_name:
type: string
liquid_material_name:
default: NMP
type: string
speed:
type: string
temperature:
type: string
titration:
type: string
required:
- titration
type: object
result: {}
required:
- goal
title: batch_create_90_10_vial_feeding_tasks参数
type: object
type: UniLabJsonCommand
auto-batch_create_diamine_solution_tasks:
feedback: {}
goal: {}
goal_default:
delay_time: null
liquid_material_name: NMP
solutions: null
speed: null
temperature: null
handles: {}
placeholder_keys: {}
result: {}
schema:
description: ''
properties:
feedback: {}
goal:
properties:
delay_time:
type: string
liquid_material_name:
default: NMP
type: string
solutions:
type: string
speed:
type: string
temperature:
type: string
required:
- solutions
type: object
result: {}
required:
- goal
title: batch_create_diamine_solution_tasks参数
type: object
type: UniLabJsonCommand
auto-brief_step_parameters:
feedback: {}
goal: {}
goal_default:
data: null
handles: {}
placeholder_keys: {}
result: {}
schema:
description: ''
properties:
feedback: {}
goal:
properties:
data:
type: object
required:
- data
type: object
result: {}
required:
- goal
title: brief_step_parameters参数
type: object
type: UniLabJsonCommand
auto-compute_experiment_design:
feedback: {}
goal: {}
goal_default:
m_tot: '70'
ratio: null
titration_percent: '0.03'
wt_percent: '0.25'
handles: {}
placeholder_keys: {}
result: {}
schema:
description: ''
properties:
feedback: {}
goal:
properties:
m_tot:
default: '70'
type: string
ratio:
type: object
titration_percent:
default: '0.03'
type: string
wt_percent:
default: '0.25'
type: string
required:
- ratio
type: object
result:
properties:
feeding_order:
items: {}
title: Feeding Order
type: array
return_info:
title: Return Info
type: string
solutions:
items: {}
title: Solutions
type: array
solvents:
additionalProperties: true
title: Solvents
type: object
titration:
additionalProperties: true
title: Titration
type: object
required:
- solutions
- titration
- solvents
- feeding_order
- return_info
title: ComputeExperimentDesignReturn
type: object
required:
- goal
title: compute_experiment_design参数
type: object
type: UniLabJsonCommand
auto-process_order_finish_report:
feedback: {}
goal: {}
goal_default:
report_request: null
used_materials: null
handles: {}
placeholder_keys: {}
result: {}
schema:
description: ''
properties:
feedback: {}
goal:
properties:
report_request:
type: string
used_materials:
type: string
required:
- report_request
- used_materials
type: object
result: {}
required:
- goal
title: process_order_finish_report参数
type: object
type: UniLabJsonCommand
auto-project_order_report:
feedback: {}
goal: {}
goal_default:
order_id: null
handles: {}
placeholder_keys: {}
result: {}
schema:
description: ''
properties:
feedback: {}
goal:
properties:
order_id:
type: string
required:
- order_id
type: object
result: {}
required:
- goal
title: project_order_report参数
type: object
type: UniLabJsonCommand
auto-query_resource_by_name:
feedback: {}
goal: {}
goal_default:
material_name: null
handles: {}
placeholder_keys: {}
result: {}
schema:
description: ''
properties:
feedback: {}
goal:
properties:
material_name:
type: string
required:
- material_name
type: object
result: {}
required:
- goal
title: query_resource_by_name参数
type: object
type: UniLabJsonCommand
auto-transfer_materials_to_reaction_station:
feedback: {}
goal: {}
goal_default:
target_device_id: null
transfer_groups: null
handles: {}
placeholder_keys: {}
result: {}
schema:
description: ''
properties:
feedback: {}
goal:
properties:
target_device_id:
type: string
transfer_groups:
type: array
required:
- target_device_id
- transfer_groups
type: object
result: {}
required:
- goal
title: transfer_materials_to_reaction_station参数
type: object
type: UniLabJsonCommand
auto-wait_for_multiple_orders_and_get_reports:
feedback: {}
goal: {}
goal_default:
batch_create_result: null
check_interval: 10
timeout: 7200
handles: {}
placeholder_keys: {}
result: {}
schema:
description: ''
properties:
feedback: {}
goal:
properties:
batch_create_result:
type: string
check_interval:
default: 10
type: integer
timeout:
default: 7200
type: integer
required: []
type: object
result: {}
required:
- goal
title: wait_for_multiple_orders_and_get_reports参数
type: object
type: UniLabJsonCommand
auto-workflow_sample_locations:
feedback: {}
goal: {}
goal_default:
workflow_id: null
handles: {}
placeholder_keys: {}
result: {}
schema:
description: ''
properties:
feedback: {}
goal:
properties:
workflow_id:
type: string
required:
- workflow_id
type: object
result: {}
required:
- goal
title: workflow_sample_locations参数
type: object
type: UniLabJsonCommand
create_90_10_vial_feeding_task:
feedback: {}
goal:
delay_time: delay_time
hold_m_name: hold_m_name
order_name: order_name
percent_10_1_assign_material_name: percent_10_1_assign_material_name
percent_10_1_liquid_material_name: percent_10_1_liquid_material_name
percent_10_1_target_weigh: percent_10_1_target_weigh
percent_10_1_volume: percent_10_1_volume
percent_10_2_assign_material_name: percent_10_2_assign_material_name
percent_10_2_liquid_material_name: percent_10_2_liquid_material_name
percent_10_2_target_weigh: percent_10_2_target_weigh
percent_10_2_volume: percent_10_2_volume
percent_10_3_assign_material_name: percent_10_3_assign_material_name
percent_10_3_liquid_material_name: percent_10_3_liquid_material_name
percent_10_3_target_weigh: percent_10_3_target_weigh
percent_10_3_volume: percent_10_3_volume
percent_90_1_assign_material_name: percent_90_1_assign_material_name
percent_90_1_target_weigh: percent_90_1_target_weigh
percent_90_2_assign_material_name: percent_90_2_assign_material_name
percent_90_2_target_weigh: percent_90_2_target_weigh
percent_90_3_assign_material_name: percent_90_3_assign_material_name
percent_90_3_target_weigh: percent_90_3_target_weigh
speed: speed
temperature: temperature
goal_default:
delay_time: ''
hold_m_name: ''
order_name: ''
percent_10_1_assign_material_name: ''
percent_10_1_liquid_material_name: ''
percent_10_1_target_weigh: ''
percent_10_1_volume: ''
percent_10_2_assign_material_name: ''
percent_10_2_liquid_material_name: ''
percent_10_2_target_weigh: ''
percent_10_2_volume: ''
percent_10_3_assign_material_name: ''
percent_10_3_liquid_material_name: ''
percent_10_3_target_weigh: ''
percent_10_3_volume: ''
percent_90_1_assign_material_name: ''
percent_90_1_target_weigh: ''
percent_90_2_assign_material_name: ''
percent_90_2_target_weigh: ''
percent_90_3_assign_material_name: ''
percent_90_3_target_weigh: ''
speed: ''
temperature: ''
handles: {}
result:
return_info: return_info
schema:
description: ''
properties:
feedback:
properties: {}
required: []
title: DispenStationVialFeed_Feedback
type: object
goal:
properties:
delay_time:
type: string
hold_m_name:
type: string
order_name:
type: string
percent_10_1_assign_material_name:
type: string
percent_10_1_liquid_material_name:
type: string
percent_10_1_target_weigh:
type: string
percent_10_1_volume:
type: string
percent_10_2_assign_material_name:
type: string
percent_10_2_liquid_material_name:
type: string
percent_10_2_target_weigh:
type: string
percent_10_2_volume:
type: string
percent_10_3_assign_material_name:
type: string
percent_10_3_liquid_material_name:
type: string
percent_10_3_target_weigh:
type: string
percent_10_3_volume:
type: string
percent_90_1_assign_material_name:
type: string
percent_90_1_target_weigh:
type: string
percent_90_2_assign_material_name:
type: string
percent_90_2_target_weigh:
type: string
percent_90_3_assign_material_name:
type: string
percent_90_3_target_weigh:
type: string
speed:
type: string
temperature:
type: string
required:
- order_name
- percent_90_1_assign_material_name
- percent_90_1_target_weigh
- percent_90_2_assign_material_name
- percent_90_2_target_weigh
- percent_90_3_assign_material_name
- percent_90_3_target_weigh
- percent_10_1_assign_material_name
- percent_10_1_target_weigh
- percent_10_1_volume
- percent_10_1_liquid_material_name
- percent_10_2_assign_material_name
- percent_10_2_target_weigh
- percent_10_2_volume
- percent_10_2_liquid_material_name
- percent_10_3_assign_material_name
- percent_10_3_target_weigh
- percent_10_3_volume
- percent_10_3_liquid_material_name
- speed
- temperature
- delay_time
- hold_m_name
title: DispenStationVialFeed_Goal
type: object
result:
properties:
return_info:
type: string
required:
- return_info
title: DispenStationVialFeed_Result
type: object
required:
- goal
title: DispenStationVialFeed
type: object
type: DispenStationVialFeed
create_diamine_solution_task:
feedback: {}
goal:
delay_time: delay_time
hold_m_name: hold_m_name
liquid_material_name: liquid_material_name
material_name: material_name
order_name: order_name
speed: speed
target_weigh: target_weigh
temperature: temperature
volume: volume
goal_default:
delay_time: ''
hold_m_name: ''
liquid_material_name: ''
material_name: ''
order_name: ''
speed: ''
target_weigh: ''
temperature: ''
volume: ''
handles: {}
result:
return_info: return_info
schema:
description: ''
properties:
feedback:
properties: {}
required: []
title: DispenStationSolnPrep_Feedback
type: object
goal:
properties:
delay_time:
type: string
hold_m_name:
type: string
liquid_material_name:
type: string
material_name:
type: string
order_name:
type: string
speed:
type: string
target_weigh:
type: string
temperature:
type: string
volume:
type: string
required:
- order_name
- material_name
- target_weigh
- volume
- liquid_material_name
- speed
- temperature
- delay_time
- hold_m_name
title: DispenStationSolnPrep_Goal
type: object
result:
properties:
return_info:
type: string
required:
- return_info
title: DispenStationSolnPrep_Result
type: object
required:
- goal
title: DispenStationSolnPrep
type: object
type: DispenStationSolnPrep
module: unilabos.devices.workstation.bioyond_studio.dispensing_station:BioyondDispensingStation
status_types: {}
type: python
config_info: []
description: ''
handles: []
icon: ''
init_param_schema:
config:
properties:
config:
type: string
deck:
type: string
required:
- config
- deck
type: object
data:
properties: {}
required: []
type: object
version: 1.0.0

Some files were not shown because too many files have changed in this diff Show More