跳到主要内容

save_output_params_x 保存PPS_TOD输出参数配置_X86使用

POST /api/v1/gnss/save_output_params_x​

描述​

X86平台使用的获取PPS_TOD输出参数配置的接口，获取PPS_TOD输出参数配置。 与CS1588的最大区别是输出口可能有多个，且分为虚拟和物理口两种类型，目前支持最多4个口，后续有需求可以扩展。

访问权限​

具备以下权限：

pps_tod:save_output_params_x

JSON参数​

请求参数如下：

{
  "id": 0|1|2|3,
  "portName": string,
  "baudRate": "4800"|"9600"|"19200"|"38400"|"57600"|"115200",
  "outputFormat": "rmc"|"zda"|"cm",
  "ppsOutputAdjust": number,
  "ppsOutputPulseWidth": number,
  "rmcPositionStatus": "alwaysA"|"alwaysV"|"clockSync",
  "portEnable": "enable"|"disable",
  "portType": "virtual"|"physical"
}

示例：

{
  "id": 0,
  "portName": "/dev/ttyTOD",
  "baudRate": "115200",
  "outputFormat": "rmc",
  "ppsOutputAdjust": 0,
  "ppsOutputPulseWidth": 50,
  "rmcPositionStatus": "alwaysA",
  "portType": "virtual",
  "portEnable": "enable"
}
提示
  • id: TOD_OUT端口编号，从0开始，到3为止
  • portName: 映射的串口名称
  • baudRate: 串口波特率
  • outputFormat: TOD输出格式，包括rmc、zda和cm
  • ppsOutputAdjust: 输出延迟，目前不支持该功能，配置无效
  • ppsOutputPulseWidth: 输出PPS的占空比，取值10-50，单位%，目前不支持该功能，配置无效
  • rmcPositionStatus：输出RMC消息时，定位状态，包括 alwaysA、alwaysV和clockSync
    • alwaysA：RMC报文中的A/V标志始终为A
    • alwaysV：RMC报文中的A/V标志始终为V
    • clockSync：RMC报文中的A/V标志根据上游传入的CM报文中的状态字段值进行设置
  • portEnable: 端口使能，enable表示使能，disable表示不使能
  • portType: 端口类型，包括虚拟和物理，虚拟是向系统内部的虚拟串口输出，物理是向系统外部的物理接口输出

响应结果​

请求返回的HTTP状态码为200

返回结果为JSON格式的数据，您可以通过解析JSON数据来获取API调用的结果信息。结构如下：

{
  "success": true|false,
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}

正确结果示例：

{
  "success": true
}

错误码​

错误码说明错误信息显示类型
40007缺少请求参数对象error.request.format4
40007id不能为空error.request.id4
40007id超出范围request.id.out.of.range4
40007串口名称不能为空error.request.portName4
40007串口波特率不能为空error.format.baud.rate4
40007串口波特率无效error.format.baud.rate.invalid4
40007输出格式不能为空error.request.output.format4
40007输出格式仅支持rmc,zda或cmoutput.format.must.be.cm.zda.or.rmc4
40007输出延迟不能为空error.request.pps.output.adjust4
40007输出占空比不能为空error.request.pps.output.pulse.width4
40007输出占空比必须在10到50之间pps.output.pulse.width.must.between.10.to.504
40007RMC定位状态模式不能为空error.request.rmc.position.status4
40007RMC定位状态模式无效error.format.baud.rate.invalid4
40007端口使能不能为空error.request.port.enable4
40007端口使能必须是enable或disableport.enable.must.be.enable.or.disable4
40007端口类型不能为空error.request.port.type4
40007端口类型必须是虚拟或物理port.type.must.be.virtual.or.physical4
40007保存配置失败error.request.save_config4
提示

4 表示错误, 弹出错误提示框