API 功能支持 ¶

本文档主要介绍 API 功能支持具体内容。

• API 调用示例参考 调用示例 （[SimOne 安装目录]\SimOne\SimOneAPI ）

1. 基础服务类 ¶

1.1 ServiceAPI ¶

1.1.1 选择车辆并初始化 ¶

1.1.2 获取主车状态 ¶

SimOne_Data_MainVehicle_Status 结构体说明：

1.1.3 其他函数说明 ¶

SimOne_Data_CaseInfo 如下：

SimOne_Data_MainVehicle_Info 结构如下：

SimOne_Data_Map 结构如下：

2. 传感器类 ¶

2.1 SensorAPI ¶

2.1.1 GPS ¶

GPS 获取数据的 API 有：

• mainVehicleId 为主车 ID； pGps 的数据结构 SimOne_Data_Gps 如下：

2.1.2 摄像头以及目标级摄像头 ¶

2.1.2.1 物理级摄像头

mainVehicleId 为主车 ID； sensorId 为摄像头 ID； ip 为接收机器的 ip 地址； port 为分配的端口号； pImage 为每帧图像信息； SimOne_Data_Image 的结构如下：

1 与 2 方式获取物理级摄像头信息时不需要配置 UDP 信息，仅以 3 、4 的方式获取物理级图像信息时，需要在网页端订阅通道上配置 UDP 信息例如：udp://127.0.0.1:13956，截图如下：

2.1.2.2 目标级摄像头

• 其中 pGroundtruth 为目标信息集合， SimOne_Data_SensorDetections 结构如下：

• SimOne_Data_SensorDetections_Entry 结构如下：

• 其中 pLaneInfo 为车道信息集合， SimOne_Data_LaneInfo 结构如下：

2.1.3 理想传感器 ¶

• 理想传感器是用来获取目标真值的，只有目标级信息。与理想传感器相关的 API 有：

• 其中 3 4 上面已经介绍过，1 2 中 SimOne_Data_Obstacle 结构如下：

• SimOne_Data_Obstacle_Entry 结构如下：

2.1.4 超声波雷达 ¶

超声波雷达用来探测目标离传感器的相对距离，以及返回目标的位置信息，相关的 API 如下：

1 获取的是单个超声波雷达的信息，而 2 返回的是所有超波雷达信息的集合；

• SimOne_Data_UltrasonicRadar 的结构如下：

• SimOne_Data_UltrasonicRadarDetection_Entry 的结构如下：

• SimOne_Data_UltrasonicRadars 的结构如下：

2.1.5 毫米波雷达 ¶

毫米波雷达用来探测目标距离，速度，角度信息，相关的 API 如下：

• 输入：mainVehicleId 为主车 ID；sensorId 为毫米波雷达 ID；

• 输出：SimOne_Data_RadarDetection *pDetections，其结构体如下：

  • struct SimOne_Data_RadarDetection : public SimOne_Data

• struct SimOne_Data_RadarDetection_Entry

2.1.6 激光雷达以及目标级激光雷达 ¶

2.1.6.1 物理级激光雷达

mainVehicleId 为主车 ID； sensorId 为激光雷达 ID； ip 为接收机器的 ip 地址； port 为激光雷达数据端口号； infoPort 为用户配置数据端口； pPointCloud 为每帧点云信息， SimOne_Data_Point_Cloud 的结构如下：

1 与 2 方式获取激光雷达信息时不需要配置 UDP 信息，仅以 3、4 的方式获取物理级激光雷达信息时，需要在网页端通道上配置 UDP 信息例如：udp://127.0.0.1：6699，截图如下：

2.1.6.2 目标级激光雷达

其中 pGroundtruth 与 SimOne_Data_SensorDetections 结构已经在摄像头与目标级摄像头 API 中已介绍。

2.1.7 目标级融合传感器 ¶

其中 pGroundtruth 、 SimOne_Data_SensorDetections 、 SimOne_Data_LaneInfo 结构已经在摄像头与目标级摄像头 API 中已介绍。

2.2 StreamingAPI ¶

2.3 V2XAPI ¶

V2X（车联网）技术关键在于两部分设备： OBU 和 RSU ，它们通过无线通信方式实现车与车以及车与路边设施之间的互联。具体的设备功能和通信方式如下表所示：

在 CSAE2020 标准下， RSU 负责将关键安全和导航信息以广播的方式传输给车载的 OBU ，确保车辆及时获取重要通信。

详细的广播消息类型及其描述如右表所示：

2.3.1 V2X API 概览 ¶

2.3.2 API 详细说明 ¶

2.3.2.1 GetV2XInfo 函数

用于获取指定类型的 V2X 消息。

2.3.2.2 SetV2XInfoUpdateCB 函数

用于设置 V2X 消息更新的回调，确保消息实时更新且无数据丢失。

2.3.2.3 V2X 消息结构体 SimOne_Data_V2XNFS 说明:

注意 ：更详细的消息定义可参考《CSAE 2020 合作式智能运输系统 - 车用通信系统应用层及应用数据交互标准》。

3. 控制通信类 ¶

3.1 PNCAPI ¶

调用示例可参考 调用示例 。

4. 高精地图运行时类 ¶

4.1 HDMapAPI ¶

高精度地图路网运行时目前提供的 API 包括功能为： 全图查询，定位，路由，交通灯和标志牌，停车位 等。

4.1.1 基本概念 ¶

1. 坐标系统 ：对于高精度地图而言，系统提供 Local ENU 和 s-t 两种坐标系统 。

A. 世界坐标系/站心直角坐标系（Local ENU） 世界坐标系为 x，y，z 右手坐标系

惯例适用于地理参考，即对应站心直角坐标系，x 为正东（East，E），y 为正北（North，N），z 为 Up（U）。

B. 参考线坐标系/轨道系统 s-t 坐标系（Track System s-t coordinate）

路网运行时根据不同参考线基准分别定义了 2 个 s-t 坐标系：

• 以 道路参考线 为基准定义 s-t 坐标系

• 以 车道虚拟中心线 为基准定义 s-t 坐标系

3. 车道标识符 ：高精度地图中的 laneName 为车道提供了唯一标识，结合道路编号、路段索引和车道编号，实现了精准的车道信息查询和定位。

   • 标识符格式 : $roadId_sectionIndex_laneId

     • $roadId : 道路的唯一编号。

     • _sectionIndex : 道路中特定路段的索引，用于标识道路的不同部分。

     • _laneId : 车道编号，在每个路段中独一无二。

   例如：

   • "1_0_-1" 表示道路编号为 1 的路段索引 0 上的右侧第一条车道（ 负号表示右侧 ）。

   • "1_0_2" 表示同一路段上左侧的第二条车道（ 正号表示左侧 ）。

   

4. 坐标转换 ：LocalENU(x,y,z) 坐标和 [s,t] 坐标相互转换

   1. Road 参考线体系下的 [s,t] 坐标

      • 定义： 以 道路参考线 为基准线，参考线右侧 t 值为负，左侧 t 值为正

      • 例子： * *P(-51.5,-73.5)对应 Road 1 的[s,t]坐标系的值是(7,-5.25)

   2. Lane 虚拟中心线体系下的 [s,t] 坐标

      • 定义： 以 车道虚拟中心线 为基准线，基准线右侧 t 为负，左侧 t 为正，主车沿着车道虚拟中心线行驶，那么 t 值永远为 0

      • 例子 ：P(-51.5,-73.5)，对应 Lane “1_0_-2”的[s,t]坐标系的值是(7,0)；对应 Lane “1_0_-1”的[s,t]坐标系的值是(7,-3.5)

4. 定位障碍物 ：使用 Road 参考线体系下的[s,t]坐标，我们可以确定障碍物相对于主车前进方向的横向距离(t)和纵向距离(s)。

   • 定义 ：以道路参考线为基准线，参考线右侧 t 值为负，左侧 t 值为正，S 是沿着道路参考线的累加值

   • 例子 ：主车相对于道路的 ST 坐标(25，-5.25)

4.1.2 全局查询 ¶

4.1.3 定位 ¶

4.1.4 路由 ¶

5. 评价算法类 ¶

5.1 EvaluationAPI ¶

5.1.1 评价 API 功能介绍 ¶

Simone 支持用户自定义评价功能，EvaluationAPI 用于获取存储用户自定义的评价功能所需的数据，主要为：

（1）仿真过程数据，例如主车以及障碍物的位姿数据等；

（2）用户规控算法的内部输出信号，例如状态机信号、控制信号等；

5.1.2 评价 API 存储数据的方式 ¶

目前存储用户自定义评价所需数据的方式有两种：本地文件存储与数据库存储。

对应的 API 如下：

5.1.3 评价 API 添加规控算法内部信号 ¶

用户自定义评价算法需要的数据除了仿真过程数据，有些可能还需要特定的规控算法内部信号，用户可以通过 API 自行添加评价所需要的数据，例如变道信号、控制信号等。