6.9 KiB
6.9 KiB
StandardScene 开发指南
1. 项目定位
StandardScene 是一个由 SimpleComposer.exe 宿主加载的场景插件库,输出为 StandardScene.dll,不是独立 EXE。仓库主要面向 AGV/AMR 场内调度与联动控制,覆盖:
- 搬运任务与环线任务
- 区域流控与交通互锁
- 充电策略与充电桩管理
- 门禁联动与安全信号
- HTTP / MQTT / Modbus 等外围接口
2. 技术与运行方式
| 项目项 | 说明 |
|---|---|
| 语言 | C# |
| 框架 | .NET Framework 4.8 |
| 工程类型 | Library |
| 宿主 | SimpleComposer.exe |
| 关键入口 | MissionType、CarType、WebApi.cs |
本机依赖
工程文件里可见以下固定依赖路径:
D:\MDCS\Dependencies\Commons\CommonUsage.dllD:\MDCS\Dependencies\deps\LessokajiWeaverUtilities.dllD:\MDCS\Dependencies\Commons\MDCSToolBox.dllD:\MDCS\Dependencies\Simple\RefSimpleCore.dllD:\MDCS\Executables\Simple\SimpleComposer.exe
构建与运行
- 打开
StandardScene.sln - 编译
Debug|Any CPU或Release|Any CPU - 编译后,构建事件会把
StandardScene.dll复制到build\plugins - 运行
build\SimpleComposer.exe
3. 目录结构
| 路径 | 作用 |
|---|---|
CarTypes\ |
各车型与协议适配 |
Chained\ |
搬运任务、链式调度、环线任务 |
Charge\ |
充电策略、充电桩管理 |
ChargeStationType\ |
具体充电桩类型 |
InterLock\ |
区域互锁、交通控制 |
Scheduler\ |
心跳、安全、区域流控等后台 Mission |
ExtendDevice\Door\ |
门禁设备接入与联动 |
Model\ |
任务、配置、地图等数据模型 |
TCP\ / Utils\ |
TCP、JSON、Web API、Modbus 工具 |
Commons.cs |
通用字段、标签、选车、路径辅助 |
WebApi.cs |
对外 HTTP 接口 |
4. 运行时架构
运行链路通常是:
- 宿主启动并扫描
build\plugins - 加载
StandardScene.dll - 通过特性反射识别
MissionType与CarType - 启动具体 Mission
- Mission 调用
SimpleLib、TrafficControl、SegmentPlan等核心能力 - 车辆状态、交通状态、充电状态在运行时持续联动
5. 核心模块理解
Scheduler
这是最适合入门的目录。
HeartBeatMission.cs:最小线程式 MissionRegionalTrafficControlMission.cs:事件订阅型 MissionSecuritySignalMission.cs:安全信号类任务
Chained
主业务调度的核心区域。
AbstractChainedDeliveryMission.cs:搬运任务总控TransportMission.cs:常规运输 MissionAbstractLoopMission.cs:环线任务骨架LoopMission.cs:环线业务实例
Charge
负责能量与充电协同。
AbstractChargeLogicMission.csStandardChargeMission.csChargeStationDataService.csChargeStationManagementExample.cs
CarTypes
负责车型与协议适配。
VDA5050Car.csForklift.csKiva.csMultiVehicleCar.csMasterMQTTCommunication.cs
WebApi.cs
对外暴露 HTTP 能力,常见路由包括:
/car/createTask/car/getAllCars/car/goSite/map/getMap/task/getTask/mission_reflection/get_mission_list
6. 配置文件
| 文件 | 作用 |
|---|---|
Config\traffic.json |
交通互锁 / 区域配置 |
Config\ChargeStations.json |
充电桩定义 |
Config\ChargeStrategyConfig.json |
充电策略 |
Config\AlarmConfigs.json |
报警配置 |
DoorConfig.json |
门禁配置 |
tasklist.json |
环线任务配置 |
simple.json |
宿主基础配置 |
除了 JSON 文件,本仓库还大量使用 fields 与 tags 作为轻量配置入口,尤其是站点与车辆行为控制。
7. 快速开始案例
案例 A:新增一个最小 Mission
最推荐的新手入门案例,直接参考 Scheduler\HeartBeatMission.cs。
using System.Threading;
using Newtonsoft.Json;
using SimpleComposer.RCS;
using SimpleCore;
namespace StandardScene.Scheduler
{
[MissionType(Name = "Hello Mission", editor = typeof(HelloMission))]
[I18N.DocumentTranslation(Name = "Hello Mission", locale = "en")]
public class HelloMission : Mission
{
[JsonIgnore] private bool _started;
[JsonIgnore] private Thread _thread;
public static Mission Create()
{
return new HelloMission();
}
public override void Execute()
{
if (_started) return;
_started = true;
status.status = "已启动";
_thread = new Thread(() =>
{
int count = 0;
while (_started)
{
Thread.Sleep(1000);
count++;
status.status = $"tick:{count}";
}
});
_thread.Start();
}
public void Stop()
{
_started = false;
status.status = "已停止";
}
}
}
关键提醒
当前工程是旧式 .csproj,新增 .cs 文件后必须确认文件已加入工程;否则文件存在但不会参与编译。必要时手工补:
<Compile Include="Scheduler\HelloMission.cs" />
验证方式
- 编译解决方案
- 打开
build\SimpleComposer.exe - 启动
Hello Mission - 观察
status.status是否变成tick:1、tick:2
案例 B:配置区域流控
该案例对应 Scheduler\RegionalTrafficControlMission.cs。
给区域内站点添加字段:
Region1 = 1
含义是:
- 站点属于
Region1 Region1最多允许 1 台车进入
实验步骤
- 给同一区域内多个站点加上
Region1=1 - 启动“区域流量监控” Mission
- 让两台车先后进入该区域
- 观察第二台车是否被阻止
- 查看 Mission 状态中的区域统计与拦截次数
8. 开发工作流建议
- 先判断功能属于
Scheduler、Chained、Charge、CarTypes还是WebApi.cs - 找最接近的现有类作为模板
- 明确配置入口是 JSON、
fields还是tags - 补齐日志、状态与停止逻辑
- 确认文件已加入工程
- 编译后在宿主里验证是否能被识别
9. 调试建议
优先观察这些点:
status.statusDiagnosis.Post/Diagnosis.Logcar.status.pendingLockscar.status.holdingLocks- 站点 / 车辆的
fields与tags WebApi.cs中的实际路由
推荐调试方式:
- 以
build\SimpleComposer.exe作为外部程序启动调试 - 或先运行宿主,再附加进程
10. 常见坑
新增 Mission 看不到
优先检查:
- 是否加了
MissionType - 是否有静态
Create() - 是否复制到了
build\plugins - 是否已经加入
.csproj
区域流控不生效
优先检查:
- 字段名是否以
Region开头 - 字段值是否能解析为整数
- Mission 是否已启动
任务不执行
优先检查:
- 车辆是否在线
- 路径是否可达
- 是否被互锁、流控或门控拦截
- 是否已有标签将车辆标记为忙碌或充电中