Skip to main content

get_output_params_x 获取PPS_TOD输出参数配置_X86使用

POST /api/v1/pps_tod/get_output_params_x​

描述​

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

访问权限​

具备以下权限：

pps_tod:get_output_params_x

JSON参数​

请求参数：id 为TOD_OUT端口编号，从0开始

{
  "id": 0|1|2|3,
}
tip
  • id: TOD_OUT端口编号，从0开始，到3为止，如果传入则返回指定端口的配置；如果不传入则返回所有端口的配置。

响应结果​

请求返回的HTTP状态码为200

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

{
  "success": true|false,
  "data"?: [
    {
      "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"
    },
    ...
  ],
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
tip
  • 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: 端口类型，包括虚拟和物理，虚拟是向系统内部的虚拟串口输出，物理是向系统外部的物理接口输出

正确结果示例：

{
  "success": true,
  "data": [
    {
      "portName": "/dev/ttyTOD",
      "baudRate": "115200",
      "outputFormat": "rmc",
      "ppsOutputAdjust": 0,
      "ppsOutputPulseWidth": 50,
      "rmcPositionStatus": "alwaysA",
      "portEnable": "enable",
      "portType": "virtual",
      "id": 0
    },
    {
      "portName": "/dev/ttyTOD1",
      "baudRate": "115200",
      "outputFormat": "zda",
      "ppsOutputAdjust": 0,
      "ppsOutputPulseWidth": 10,
      "rmcPositionStatus": "alwaysV",
      "portEnable": "disable",
      "portType": "physical",
      "id": 1
    },
    {
      "portName": "/dev/ttyTOD1",
      "baudRate": "115200",
      "outputFormat": "zda",
      "ppsOutputAdjust": 0,
      "ppsOutputPulseWidth": 20,
      "rmcPositionStatus": "clockSync",
      "portEnable": "disable",
      "portType": "physical",
      "id": 2
    },
    {
      "portName": "/dev/ttyTOD3",
      "baudRate": "115200",
      "outputFormat": "rmc",
      "ppsOutputAdjust": 20,
      "ppsOutputPulseWidth": 30,
      "rmcPositionStatus": "clockSync",
      "portEnable": "disable",
      "portType": "physical",
      "id": 3
    }
  ]
}

错误结果示例：

{
  "success": false,
  "errorCode": "40004",
  "errorMessage": "no.blank.params",
  "showType": 4
}

错误码​