Uni-Lab-OS 项目文档

Uni-Lab-OS 是一个开源的实验室自动化操作系统，提供统一的设备接口、工作流管理和分布式部署能力。

• 核心概念
  • Uni-Lab 操作系统总览
  • 设备抽象、指令集与通信中间件
    • 设备间通信模式
    • 通信指令集
    • 通信中间件层
  • 实验室组态图
    • 父子关系、物质流与"编译"操作
    • 通信转接关系
• 用户指南
  • Uni-Lab-OS 最佳实践指南
    • 关于本指南
    • 第一部分：快速上手
    • 第二部分：进阶部署
    • 第三部分：自定义开发
    • 第四部分：最佳实践总结
    • 结语
  • Uni-Lab-OS 安装指南
    • 系统要求
    • 安装方式选择
    • 方式一：一键安装（推荐新用户）
    • 方式二：手动安装（标准用户）
    • 方式三：开发者安装
    • 验证安装
    • 常见问题
    • 下一步
    • 需要帮助？
  • Uni-Lab 启动指南
    • 启动流程详解
    • 使用配置文件
    • 初始化信息来源
    • 通信中间件 --backend
    • 端云桥接 --app_bridges
    • 分布式组网
    • 可视化选项
    • 实验室管理
    • 完整启动示例
    • 常见问题
  • 设备图文件说明
    • 概述
    • 文件格式
    • JSON 文件结构
    • 完整示例
    • 格式兼容性和转换
    • 节点类型详解
    • Handle（连接点）
    • 使用 Web 界面创建图文件
    • 从云端获取图文件
    • 调试图文件
    • 最佳实践
    • 示例文件位置
    • 快速参考：ResourceDict 完整字段列表
    • 下一步
    • 获取帮助
  • 启动样例
    • 移液站样例
    • 有机常量合成样例
• 进阶配置
  • Uni-Lab 配置指南
    • 配置文件概述
    • 获取实验室密钥
    • 配置文件格式
    • 配置优先级
    • 推荐配置方式
    • 命令行参数覆盖配置
    • 配置选项详解
    • 环境变量配置
    • 配置文件使用方法
    • 常用配置场景
    • 最佳实践
    • 故障排除
    • 配置验证
    • 相关文档
  • 工作目录详解
    • 什么是工作目录
    • 工作目录判断逻辑
    • 使用场景示例
    • 高级用法：管理多个实验室配置
    • 完整决策流程图
    • 常见问题
    • 最佳实践
    • 相关文档
• 开发者指南
  • 组网部署与主从模式配置
    • 目录
    • 架构概览
    • 节点类型
    • 通信机制
    • 典型拓扑
    • 主从模式配置
    • 网络配置
    • 示例：多房间部署
    • 故障处理
    • 监控和维护
    • 相关文档
    • 参考资料
  • 添加设备：编写驱动
    • 支持的驱动类型
    • 快速开始：两种方式添加设备
    • Python 类结构要求
    • 状态属性 vs 动作方法
    • 特殊参数类型：ResourceSlot 和 DeviceSlot
    • 支持的通信方式
    • 异步 vs 同步方法
    • 错误处理
    • 最佳实践
    • 下一步
    • 参考
  • 设备 Driver 开发（无 SDK 设备）
    • 有串口字符串指令集文档的设备：Python 串口通信（常见 RS485, RS232, USB）
    • 常见工业通信协议：Modbus（RTU, TCP）
    • 其他工业通信协议：CANopen, Ethernet, OPCUA…
    • 没有接口的老设备老软件：使用 PyWinAuto
    • 下一步
  • 添加设备：注册表配置完整指南
    • 概述
    • 快速开始：使用注册表编辑器
    • 注册表的基本结构
    • 创建注册表的方式
    • action_value_mappings 详解
    • 特殊类型的自动识别
    • 系统自动生成的字段
    • 完整示例
    • 部署和使用
    • 调试和验证
    • 常见问题
    • 最佳实践
    • 参考资料
  • yaml 注册表编写指南
    • 快速开始：使用注册表编辑器
    • 手动编写指南
    • 注册表的基本结构
    • 怎么创建新的注册表
    • action_value_mappings 怎么写
    • 系统自动生成的字段
    • 完整的例子
    • 怎么部署和使用
    • 常见问题怎么排查
    • 最佳实践
  • 添加新动作指令（Action）
    • 1. 编写新的 Action
    • 2. 在线构建和测试
    • 3. 提交 Pull Request
    • 4. 使用新的 Action
    • 常见问题
  • Uni-Lab 动作指令集
    • 简单单变量动作函数
    • 常量有机化学操作
    • 移液工作站及相关生物自动化设备操作
    • 多工作站及小车运行、物料转移
    • 机械臂、夹爪等机器人设备
  • 简单单变量动作函数
    • SendCmd
  • 常量有机化学操作
    • Clean
    • HeatChillStart
    • HeatChillStop
    • PumpTransfer
  • 移液工作站及相关生物自动化设备操作
    • LiquidHandlerDiscardTips
    • LiquidHandlerDropTips
    • LiquidHandlerDropTips96
    • LiquidHandlerMoveLid
    • LiquidHandlerMovePlate
    • LiquidHandlerMoveResource
    • LiquidHandlerPickUpTips
    • LiquidHandlerPickUpTips96
    • LiquidHandlerReturnTips
    • LiquidHandlerReturnTips96
    • LiquidHandlerStamp
  • 多工作站及小车运行、物料转移
    • AGVTransfer
    • WorkStationRun
  • 机械臂、夹爪等机器人设备
    • FollowJointTrajectory
    • GripperCommand
    • JointTrajectory
    • ParallelGripperCommand
    • PointHead
    • SingleJointPosition
    • AssistedTeleop
    • BackUp
    • ComputePathThroughPoses
    • ComputePathToPose
    • DriveOnHeading
    • DummyBehavior
    • FollowPath
    • FollowWaypoints
    • NavigateThroughPoses
    • NavigateToPose
    • SmoothPath
    • Spin
    • Wait
  • 添加新实验操作（Protocol）
  • 实例：工作站模板架构设计与对接指南
    • 0. 问题简介
    • 1. 整体架构图
    • 2. 类关系图
    • 3. 工作站启动时序图
    • 4. 工作流执行时序图（Protocol 模式）
    • 5. HTTP 报送处理时序图
    • 6. 错误处理时序图
    • 7. 典型工作站实现示例
    • 8. 核心接口说明
    • 9. 配置参数说明
    • 10. 架构设计特点总结
  • 实例：物料构建指南
    • 概述
    • 文件结构
    • 1. 桌子（Deck）构建
    • 2. 堆栈（Warehouse）构建
    • 3. 载具（Carriers）构建
    • 4. 瓶子（Bottles）构建
    • 5. 注册表配置
  • 实例：物料教程（Resource）
    • 1. 物料是什么
    • 2. 3种物料格式概览(UniLab、PyLabRobot、奔耀Bioyond)
    • 3. children 的四种结构表示
    • 4. 转换函数及调用
    • 5. 何时使用哪种格式
    • 6. 常见问题与注意事项
  • 实例：电池装配工站接入（PLC 控制）
    • 案例概述
    • 1. 新建工站文件
    • 2. 编写驱动与寄存器读写
    • 3. 本地生成注册表并校验
    • 4. 注意事项
    • 5. 扩展阅读
    • 6. 总结
• 接口文档

开发者指南

• HTTP API 指南
  • 概述
  • 快速开始
  • API 端点列表
  • 常见动作示例
  • 错误处理
  • 轮询策略
  • 相关文档
• 组网部署与主从模式配置
  • 目录
  • 架构概览
  • 节点类型
  • 通信机制
  • 典型拓扑
  • 主从模式配置
  • 网络配置
  • 示例：多房间部署
  • 故障处理
  • 监控和维护
  • 相关文档
  • 参考资料
• 添加设备：编写驱动
  • 支持的驱动类型
  • 快速开始：两种方式添加设备
  • Python 类结构要求
  • 状态属性 vs 动作方法
  • 特殊参数类型：ResourceSlot 和 DeviceSlot
  • 支持的通信方式
  • 异步 vs 同步方法
  • 错误处理
  • 最佳实践
  • 下一步
  • 参考
• 添加新动作指令（Action）
  • 1. 编写新的 Action
  • 2. 在线构建和测试
  • 3. 提交 Pull Request
  • 4. 使用新的 Action
  • 常见问题
• 添加设备：注册表配置完整指南
  • 概述
  • 快速开始：使用注册表编辑器
  • 注册表的基本结构
  • 创建注册表的方式
  • action_value_mappings 详解
  • 特殊类型的自动识别
  • 系统自动生成的字段
  • 完整示例
  • 部署和使用
  • 调试和验证
  • 常见问题
  • 最佳实践
  • 参考资料
• yaml 注册表编写指南
  • 快速开始：使用注册表编辑器
  • 手动编写指南
  • 注册表的基本结构
  • 怎么创建新的注册表
  • action_value_mappings 怎么写
  • 系统自动生成的字段
  • 完整的例子
  • 怎么部署和使用
  • 常见问题怎么排查
  • 最佳实践
• 简单单变量动作函数
  • SendCmd
• 常量有机化学操作
  • Clean
  • HeatChillStart
  • HeatChillStop
  • PumpTransfer
• 移液工作站及相关生物自动化设备操作
  • LiquidHandlerDiscardTips
  • LiquidHandlerDropTips
  • LiquidHandlerDropTips96
  • LiquidHandlerMoveLid
  • LiquidHandlerMovePlate
  • LiquidHandlerMoveResource
  • LiquidHandlerPickUpTips
  • LiquidHandlerPickUpTips96
  • LiquidHandlerReturnTips
  • LiquidHandlerReturnTips96
  • LiquidHandlerStamp
• 多工作站及小车运行、物料转移
  • AGVTransfer
  • WorkStationRun
• 机械臂、夹爪等机器人设备
  • FollowJointTrajectory
  • GripperCommand
  • JointTrajectory
  • ParallelGripperCommand
  • PointHead
  • SingleJointPosition
  • AssistedTeleop
  • BackUp
  • ComputePathThroughPoses
  • ComputePathToPose
  • DriveOnHeading
  • DummyBehavior
  • FollowPath
  • FollowWaypoints
  • NavigateThroughPoses
  • NavigateToPose
  • SmoothPath
  • Spin
  • Wait