API Documentation

 

Constants

Core Module Constants PolySync uses constants in preference to macros because constants provide strong type checking.

CORE_MODULE_VERSION_MAJOR
Value Type Description
2 DDS_octet Core module major version. Indicates a major release version.
CORE_MODULE_VERSION_MINOR
Value Type Description
0 DDS_octet Core module minor version. Indicates a minor release version. Increased each time the syntax of the module is changed (i.e. new or removed messages, new or removed message fields, changed number of bits, etc.).
CORE_MODULE_VERSION_SUBMINOR
Value Type Description
2 DDS_unsigned_short Core module sub-minor version. Indicates a sub-minor release version. Increased each time the semantics of the data model are modified (i.e. interpretation of field values or similar).

PSYNC_DEFAULT_DOMAIN

This value can be used when specifying the desired domain a node should participate in (i.e. when calling function psync_init). When using this value, the domain identifier is determined from the system’s configuration environment. This allows changing the domain identifier at runtime on a per-host basis. The default PolySync configuration environment domain identifier is 0.

Value Type Description
0x7FFFFFFF DDS_unsigned_long Default PolySync domain ID.

PSYNC_DEFAULT_PARTITION_NAME

Value Type Description
“PSYNCP0” DDS_sequence_char Default PolySync partition name.

PSYNC_HOME_ENVIRONMENT_NAME

Value Type Description
“PSYNC_HOME” DDS_sequence_char PolySync home environment variable name.

PSYNC_SDF_FILE_NAME

Value Type Description
“psync.sdf” DDS_sequence_char PolySync system design file name.

PSYNC_MODULE_VERIFY_HASH_LEN

Value Type Description
16 DDS_unsigned_short Size of module verification hash in bytes.

PSYNC_DEFAULT_STRING_LEN

Value Type Description
2048 DDS_unsigned_short Default string size used in PolySync in bytes.

PSYNC_EVENT_ID_MAX

User event identifiers must be larger than this value. Event ID values 0 to 4095 inclusive (bits 0 to 11) are reserved for PolySync use only.

Value Type Description
4095 ps_event_id Largest PolySync internal event identifier.

PSYNC_PARAMETER_ID_MAX

The user parameter identifiers must be larger than this value. Parameter ID values 0 to 4095 inclusive (bits 0 to 11) are reserved for PolySync use only.

Value Type Description
4095 ps_event_id Largest PolySync internal parameter identifier.

PSYNC_PLOG_RECORD_PUBLISH_INTERVAL

Value Type Description
500000 ps_timestamp Default publish interval for RnR utilities when recording in microseconds.

PSYNC_PLOG_REPLAY_PUBLISH_INTERVAL

Value Type Description
100000 ps_timestamp Default publish interval for RnR utilities when replaying in microseconds.

PSYNC_MSG_TYPE_INVALID

Value Type Description
0 ps_msg_type Invalid ps_msg_type value.

PSYNC_MSG_TYPE_MAX

Value Type Description
0xFFFFFFFF ps_msg_type Largest message type identifier value.

PSYNC_INTERFACE_ADDRESS_INVALID

Value Type Description
0 ps_interface_address Invalid ps_interface_address value.

PSYNC_INTERFACE_ADDRESS_AUTO

Value Type Description
0xFFFFFFFF ps_interface_address Value means interface address is set to ‘AUTO’.

PSYNC_SENSOR_KIND_INVALID

Value Type Description
0 ps_sensor_kind Invalid ps_sensor_kind value.

PSYNC_SENSOR_KIND_UNKNOWN

Value Type Description
1 ps_sensor_kind Unknown ps_sensor_kind value.

PSYNC_SENSOR_KIND_NOT_AVAILABLE

Value Type Description
2 ps_sensor_kind ps_sensor_kind value not available.

PSYNC_GUID_INVALID

Value Type Description
0 ps_guid Invalid ps_guid value.

PSYNC_RNR_SESSION_ID_INVALID

Value Type Description
0 ps_rnr_session_id Invalid ps_rnr_session_id value.

PSYNC_CLOCK_SCALE_INVALID

Value Type Description
-1.0 DDS_double Invalid clock scale value.

PSYNC_FILE_TRANSFER_PATH_LENGTH

Value Type Description
512 DDS_unsigned_short Maximum file transfer path length.

PSYNC_IDENTIFIER_INVALID

Value Type Description
0 ps_identifier Invalid ps_identifier value.

PSYNC_IDENTIFIER_NOT_AVAILABLE

Value Type Description
1 ps_identifier Support for ps_identifier is not available.

PSYNC_NODE_TYPE_INVALID

Value Type Description
0 ps_node_type Invalid ps_node_type value.

PSYNC_NODE_TYPE_ALL

Value Type Description
0xFFFF ps_node_type ps_node_type value specifies all types.

PSYNC_NODE_TYPE_API_USER

Value Type Description
1 ps_node_type PolySync generic API-user node type.

PSYNC_NODE_TYPE_MANAGER

Value Type Description
2 ps_node_type PolySync manager node type.

PSYNC_NODE_TYPE_STUDIO

Value Type Description
3 ps_node_type PolySync studio node type.

PSYNC_NODE_TYPE_STUDIO_PLUGIN

Value Type Description
4 ps_node_type PolySync studio-plugin node type.

PSYNC_NODE_TYPE_SIMULATION_PLUGIN

Value Type Description
5 ps_node_type PolySync simulation-plugin node type.

PSYNC_NODE_TYPE_HARDWARE_DRIVER

Value Type Description
6 ps_node_type PolySync sensor driver node type.

PSYNC_NODE_TYPE_SOFTWARE_DRIVER

Value Type Description
7 ps_node_type PolySync sensor driver node type.

PSYNC_NODE_TYPE_SOFTWARE_ALGORITHM

Value Type Description
8 ps_node_type PolySync software algorithm node type.

PSYNC_COORDINATE_FRAME_INVALID

Value Type Description
0 ps_identifier Invalid PolySync coordinate frame value.

PSYNC_COORDINATE_FRAME_UNKNOWN

Value Type Description
1 ps_identifier Unknown PolySync coordinate frame value.

PSYNC_COORDINATE_FRAME_NOT_AVAILABLE

Value Type Description
2 ps_identifier PolySync coordinate frame value not available.

PSYNC_COORDINATE_FRAME_LOCAL

The standard right handed PolySync local coordinate frame.

Value Type Description
3 ps_identifier Local coordinate frame.

PSYNC_COORDINATE_FRAME_PLATFORM

The standard right handed PolySync platform coordinate frame. This is fixed in the platform body, i.e. a fixed body coordinate system.

Value Type Description
4 ps_identifier Platform coordinate frame.

PSYNC_COORDINATE_FRAME_RELATIVE

The standard right handed PolySync relative coordinate frame. Typically based on a dead-reckoned navigation solution.

Value Type Description
5 ps_identifier Relative coordinate frame.

PSYNC_COORDINATE_FRAME_ABSOLUTE

The standard right handed PolySync absolute coordinate frame. Typically based on an absolute or world navigation solution like WGS84 UTM coordinate frame in a given zone.

Value Type Description
6 ps_identifier Absolute coordinate frame.

PSYNC_PARAMETER_FLAG_DISABLED

Value Type Description
0x01 DDS_octet Parameter flag-bit 0 - parameter is disabled.

PSYNC_PARAMETER_FLAG_USERDEFINED

Value Type Description
0x02 DDS_octet Parameter flag-bit 1 - parameter is user defined.

PSYNC_PARAMETER_FLAG_READONLY_VALUE

Value Type Description
0x04 DDS_octet Parameter flag-bit 2 - parameter value is read-only.

PSYNC_PARAMETER_FLAG_READONLY_MIN

Value Type Description
0x08 DDS_octet Parameter flag-bit 3 - parameter range minimum value is read-only.

PSYNC_PARAMETER_FLAG_READONLY_MAX

Value Type Description
0x10 DDS_octet Parameter flag-bit 4 - parameter range maximum value is read-only.

PSYNC_PARAMETER_FLAG_READONLY_STEP

Value Type Description
0x20 DDS_octet Parameter flag-bit 5 - parameter range step value is read-only.

PSYNC_PARAMETER_FLAG_ANALYTIC

Value Type Description
0x40 DDS_octet Parameter flag-bit 6 - parameter is part of the analytics set.

PSYNC_NATIVE_TIMESTAMP_FORMAT_INVALID

Value Type Description
0 DDS_octet Invalid native timestamp format.

PSYNC_NATIVE_TIMESTAMP_FORMAT_UNKNOWN

Value Type Description
1 DDS_octet Unknown native timestamp format.

PSYNC_NATIVE_TIMESTAMP_FORMAT_NOT_AVAILABLE

Value Type Description
2 DDS_octet Native timestamp format not available.

PSYNC_NATIVE_TIMESTAMP_FORMAT_RELATIVE_MILLI

Value Type Description
3 DDS_octet Relative milliseconds since power-up.

PSYNC_NATIVE_TIMESTAMP_FORMAT_RELATIVE_MICRO

Value Type Description
4 DDS_octet Relative microseconds since power-up.

PSYNC_NATIVE_TIMESTAMP_FORMAT_ABSOLUTE_NTP64

NTP64 timestamps represent the time encoded in 8 bytes. In order to decode NTP64 timestamps, the corresponding 8 bytes need to be interpreted as UINT64: The higher 4 bytes are the number of seconds since 1.1.1900 - 0:00:00. The lower 4 bytes represent the fractional seconds with a resolution of 2 to 32 seconds.

Value Type Description
5 DDS_octet Absolute NTP timestamp.

PSYNC_COMMAND_ID_MAX

Value Type Description
65535 ps_command_id Largest PolySync internal command identifier.

PSYNC_COMMAND_ID_INVALID

The reserved command identifier.

Value Type Description
0 ps_command_id Invalid ps_command_id value.

PSYNC_COMMAND_GET_MANAGER_STATUS

Command Data: N/A

Response:

Response Data: N/A

Value Type Description
100 ps_command_id Get Manager node status command identifier.

PSYNC_COMMAND_ENABLE_MANAGER_REPLAY_MODE

Command Data: N/A

Response:

Response Data: N/A

Value Type Description
101 ps_command_id Enable Manager node replay mode command identifier.

PSYNC_COMMAND_ENABLE_MANAGER_RECORD_MODE

Command Data: N/A

Response:

Response Data: N/A

Value Type Description
102 ps_command_id Enable Manager node record mode command identifier.

PSYNC_COMMAND_DISABLE_MANAGER_NODES

Command Data: N/A

Response:

Response Data: N/A

Value Type Description
103 ps_command_id Disable Manager node runtime nodes command identifier.

PSYNC_COMMAND_RESTART_MANAGER

Command Data: N/A

Response:

Response Data: N/A

Value Type Description
104 ps_command_id Restart Manager node command identifier.

PSYNC_COMMAND_FORCE_MANAGER_SYNC

This will forcefully re-synchronize the RnR clock resources.

Command Data: N/A

Response:

Response Data: N/A

Value Type Description
105 ps_command_id Force Manager re-synchronization command identifier.

PSYNC_COMMAND_SET_MANAGER_RUNTIME_KEY

Command Data: - Expects data element zero to be type unsigned long long - \ref PSYNC_SDF_ID_INVALID is invalid

Response:

Response Data: N/A

Value Type Description
106 ps_command_id Set the runtime SDF configuration primary key command identifier.

PSYNC_COMMAND_SET_MANAGER_SDF_PATH

This setting will only persist for the life-cycle of the manager node.

Command Data:

  • Expects data element zero to be a fully qualified path with type DDS_sequence_char.
  • A NULL DDS_sequence_char buffer/length means to reset to the default SDF path.

Response:

Response Data: N/A

Value Type Description
107 ps_command_id Set the SDF path used by the PolySync Manager and the nodes it manages.

DTC_NONE

The reserved diagnostic trouble code.

Value Type Description
0 ps_dtc No error.

DTC_USAGE

The reserved diagnostic trouble code.

Value Type Description
20 ps_dtc Usage error.

DTC_NOSDF

The reserved diagnostic trouble code.

Value Type Description
40 ps_dtc System design file not accessible.

DTC_BADSDF

The reserved diagnostic trouble code.

Value Type Description
41 ps_dtc System design file corrupt.

DTC_SDFKEY

The reserved diagnostic trouble code.

Value Type Description
42 ps_dtc System design file key invalid.

DTC_PDMCONFIG

The reserved diagnostic trouble code.

Value Type Description
50 ps_dtc Data model configuration error.

DTC_PDMCORE_VERSION

The reserved diagnostic trouble code.

Value Type Description
51 ps_dtc Data model ‘core’ module version is not supported by the API version.

DTC_INTR

The reserved diagnostic trouble code.

Value Type Description
70 ps_dtc Interrupted system call error.

DTC_INPROGRESS

The reserved diagnostic trouble code.

Value Type Description
75 ps_dtc Operation in progress error.

DTC_DATAERR

The reserved diagnostic trouble code.

Value Type Description
100 ps_dtc Data format error.

DTC_NOINPUT

The reserved diagnostic trouble code.

Value Type Description
102 ps_dtc Cannot open input.

DTC_NOUSER

The reserved diagnostic trouble code.

Value Type Description
103 ps_dtc Address unknown.

DTC_NOHOST

The reserved diagnostic trouble code.

Value Type Description
104 ps_dtc Host name unknown.

DTC_UNAVAILABLE

The reserved diagnostic trouble code.

Value Type Description
105 ps_dtc Service unavailable.

DTC_OSERR

The reserved diagnostic trouble code.

Value Type Description
106 ps_dtc System error.

DTC_MEMERR

The reserved diagnostic trouble code.

Value Type Description
107 ps_dtc Memory error.

DTC_OSFILE

The reserved diagnostic trouble code.

Value Type Description
108 ps_dtc Critical OS file missing.

DTC_CANTCREAT

The reserved diagnostic trouble code.

Value Type Description
109 ps_dtc Can’t create output file.

DTC_IOERR

The reserved diagnostic trouble code.

Value Type Description
110 ps_dtc Input/output error.

DTC_PROTOCOL

The reserved diagnostic trouble code.

Value Type Description
111 ps_dtc Error in protocol.

DTC_NOPERM

The reserved diagnostic trouble code.

Value Type Description
112 ps_dtc Permission denied.

DTC_CONFIG

The reserved diagnostic trouble code.

Value Type Description
113 ps_dtc Configuration error.

DTC_ENVERR

The reserved diagnostic trouble code.

Value Type Description
114 ps_dtc Runtime environment error.

DTC_LICERR

The reserved diagnostic trouble code.

Value Type Description
115 ps_dtc License error.

DTC_TYPESUPPORT

The reserved diagnostic trouble code.

Value Type Description
116 ps_dtc Message/resource type is not supported.

DTC_BADDEVICEINIT

The reserved diagnostic trouble code.

Value Type Description
300 ps_dtc Bad device initialization.

DTC_NODEVICEINIT

The reserved diagnostic trouble code.

Value Type Description
301 ps_dtc No device initialization.

DTC_NODEVICEPWR

The reserved diagnostic trouble code.

Value Type Description
302 ps_dtc Device not powered.

DTC_DEVICEDAMAGED

The reserved diagnostic trouble code.

Value Type Description
303 ps_dtc Device damaged.

DTC_NOINTERFACE

The reserved diagnostic trouble code.

Value Type Description
304 ps_dtc Interface not connected.

DTC_INTERFACEPROTOCOL

The reserved diagnostic trouble code.

Value Type Description
305 ps_dtc Interface protocol violated.

DTC_INTERFACESATURATED

The reserved diagnostic trouble code.

Value Type Description
306 ps_dtc Interface saturated.

DTC_INTERFACEINUSE

The reserved diagnostic trouble code.

Value Type Description
307 ps_dtc Interface in use.

DTC_NONATIVEBUS

The reserved diagnostic trouble code.

Value Type Description
308 ps_dtc Native bus not connected.

DTC_NATIVEBUSPROTOCOL

The reserved diagnostic trouble code.

Value Type Description
309 ps_dtc Native bus protocol violated.

DTC_NATIVEBUSSATURATED

The reserved diagnostic trouble code.

Value Type Description
310 ps_dtc Native bus saturated.

DTC_NATIVEBUSINUSE

The reserved diagnostic trouble code.

Value Type Description
311 ps_dtc Native bus in use.

PSYNC_PARAM_ID_INVALID

The reserved parameter ID.

Value Type Description
0 ps_parameter_id Invalid ps_parameter_id value.

PSYNC_PARAM_ID_ALL

The reserved parameter ID.

Value Type Description
1 ps_parameter_id Special ps_parameter_id value used to specify all parameters supported by the receiver.

PSYNC_PARAM_ID_API_VERSION_DATA

Reserved parameter ID.

Value Type Description
10 ps_parameter_id PolySync API version data

PSYNC_PARAM_ID_CORE_VERSION_DATA

The reserved parameter ID.

Value Type Description
11 ps_parameter_id PolySync data model ‘core’ module version data.

PSYNC_PARAM_ID_STATIC_BACKWARDTIME_OFFSET

The reserved parameter ID.

The static time offset to subtract system time by.

Value Type Description
20 ps_parameter_id Static backward time offset.

PSYNC_PARAM_ID_STATIC_FORWARDTIME_OFFSET

The reserved parameter ID. The static time offset to add to system time.

Value Type Description
ps_parameter_id Static forward time offset.

PSYNC_PARAM_ID_EX_FILE_PATH

Reserved parameter ID.

Value Type Description
40 ps_parameter_id Executable file path.

PSYNC_PARAM_ID_EX_OPT_ARGS

The reserved parameter ID.

Value Type Description
41 ps_parameter_id Executable command-line arguments.

PSYNC_PARAM_ID_PAL_IFACE_FILE

The reserved parameter ID.

Value Type Description
42 ps_parameter_id PolySync-Abstraction-Layer interface file name.

PSYNC_PARAM_ID_SDF_CSV_KEYLIST_0

The reserved parameter ID.

Value Type Description
50 ps_parameter_id SDF CSV key list 0.

PSYNC_PARAM_ID_SDF_CSV_KEYLIST_DESC_0

The reserved parameter ID.

Value Type Description
51 ps_parameter_id SDF CSV key list description 0.

PSYNC_PARAM_ID_SDF_CSV_KEYLIST_1

The reserved parameter ID.

Value Type Description
52 ps_parameter_id SDF CSV key list 1.

PSYNC_PARAM_ID_SDF_CSV_KEYLIST_DESC_1

The reserved parameter ID.

Value Type Description
53 ps_parameter_id SDF CSV key list description 1.

PSYNC_PARAM_ID_SW_KEY_0

The reserved parameter ID.

Value Type Description
80 ps_parameter_id Third party software key 0.

PSYNC_PARAM_ID_SW_KEY_DESC_0

The reserved parameter ID.

Value Type Description
81 ps_parameter_id Third party software key description 0.

PSYNC_PARAM_ID_SW_KEY_1

The reserved parameter ID.

Value Type Description
82 ps_parameter_id Third party software key 1.

PSYNC_PARAM_ID_SW_KEY_DESC_1

The reserved parameter ID.

Value Type Description
83 ps_parameter_id Third party software key description 1.

PSYNC_PARAM_ID_HOST_IP_ADDRESS

The reserved parameter ID.

Value Type Description
110 ps_parameter_id Host PolySync network interface address.

PSYNC_PARAM_ID_HOST_CPU_COUNT

The reserved parameter ID.

Value Type Description
111 ps_parameter_id Host CPU count.

PSYNC_PARAM_ID_HOST_CPU_LOAD

The reserved parameter ID.

Value Type Description
112 ps_parameter_id Average host CPU load.

PSYNC_PARAM_ID_CAN0_HW_ID

The reserved parameter ID.

Value Type Description
400 ps_parameter_id CAN channel 0 hardware identifier.

PSYNC_PARAM_ID_CAN0_CC_ID

The reserved parameter ID.

Value Type Description
401 ps_parameter_id CAN channel 0 circuit identifier.

PSYNC_PARAM_ID_CAN0_SYS_ID

The reserved parameter ID.

Value Type Description
402 ps_parameter_id CAN channel 0 system identifier.

PSYNC_PARAM_ID_CAN0_DATARATE

The reserved parameter ID.

Value Type Description
403 ps_parameter_id CAN channel 0 datarate.

PSYNC_PARAM_ID_CAN0_ONBUS_STATE

The reserved parameter ID.

Value Type Description
404 ps_parameter_id CAN channel 0 bus on/off state.

PSYNC_PARAM_ID_CAN1_HW_ID

The reserved parameter ID.

Value Type Description
405 ps_parameter_id CAN channel 1 hardware identifier.

PSYNC_PARAM_ID_CAN1_CC_ID

The reserved parameter ID.

Value Type Description
406 ps_parameter_id CAN channel 1 circuit identifier.

PSYNC_PARAM_ID_CAN1_SYS_ID

The reserved parameter ID.

Value Type Description
407 ps_parameter_id CAN channel 1 system identifier.

PSYNC_PARAM_ID_CAN1_DATARATE

The reserved parameter ID.

Value Type Description
408 ps_parameter_id CAN channel 1 datarate.

PSYNC_PARAM_ID_CAN1_ONBUS_STATE

The reserved parameter ID.

Value Type Description
409 ps_parameter_id CAN channel 1 bus on/off state.

PSYNC_PARAM_ID_CAN2_HW_ID

The reserved parameter ID.

Value Type Description
410 ps_parameter_id CAN channel 1 hardware identifier.

PSYNC_PARAM_ID_CAN2_CC_ID

The reserved parameter ID.

Value Type Description
411 ps_parameter_id CAN channel 1 circuit identifier.

PSYNC_PARAM_ID_CAN2_SYS_ID

The reserved parameter ID.

Value Type Description
412 ps_parameter_id CAN channel 1 system identifier.

PSYNC_PARAM_ID_CAN2_DATARATE

The reserved parameter ID.

Value Type Description
413 ps_parameter_id CAN channel 1 datarate.

PSYNC_PARAM_ID_CAN2_ONBUS_STATE

The reserved parameter ID.

Value Type Description
414 ps_parameter_id CAN channel 1 bus on/off state.

PSYNC_PARAM_ID_CAN3_HW_ID

The reserved parameter ID.

Value Type Description
415 ps_parameter_id CAN channel 3 hardware identifier.

PSYNC_PARAM_ID_CAN3_CC_ID

The reserved parameter ID.

Value Type Description
416 ps_parameter_id CAN channel 3 circuit identifier.

PSYNC_PARAM_ID_CAN3_SYS_ID

The reserved parameter ID.

Value Type Description
417 ps_parameter_id CAN channel 3 system identifier.

PSYNC_PARAM_ID_CAN3_DATARATE

The reserved parameter ID.

Value Type Description
418 ps_parameter_id CAN channel 3 datarate.

PSYNC_PARAM_ID_CAN3_ONBUS_STATE

The reserved parameter ID.

Value Type Description
419 ps_parameter_id CAN channel 3 bus on/off state.

PSYNC_PARAM_ID_CAN4_HW_ID

The reserved parameter ID.

Value Type Description
420 ps_parameter_id CAN channel 4 hardware identifier.

PSYNC_PARAM_ID_CAN4_CC_ID

The reserved parameter ID.

Value Type Description
421 ps_parameter_id CAN channel 4 circuit identifier.

PSYNC_PARAM_ID_CAN4_SYS_ID

The reserved parameter ID.

Value Type Description
422 ps_parameter_id CAN channel 4 system identifier.

PSYNC_PARAM_ID_CAN4_DATARATE

The reserved parameter ID.

Value Type Description
423 ps_parameter_id CAN channel 4 datarate.

PSYNC_PARAM_ID_CAN4_ONBUS_STATE

The reserved parameter ID.

Value Type Description
424 ps_parameter_id CAN channel 4 bus on/off state.

PSYNC_PARAM_ID_CAN5_HW_ID

The reserved parameter ID.

Value Type Description
425 ps_parameter_id CAN channel 4 hardware identifier.

PSYNC_PARAM_ID_CAN5_CC_ID

The reserved parameter ID.

Value Type Description
426 ps_parameter_id CAN channel 5 circuit identifier.

PSYNC_PARAM_ID_CAN5_SYS_ID

The reserved parameter ID.

Value Type Description
427 ps_parameter_id CAN channel 5 system identifier.

PSYNC_PARAM_ID_CAN5_DATARATE

The reserved parameter ID.

Value Type Description
428 ps_parameter_id CAN channel 5 datarate.

PSYNC_PARAM_ID_CAN5_ONBUS_STATE

The reserved parameter ID.

Value Type Description
429 ps_parameter_id CAN channel 5 bus on/off state.

PSYNC_PARAM_ID_SOCKET0_PORT

The reserved parameter ID.

Value Type Description
500 ps_parameter_id Socket 0 port number.

PSYNC_PARAM_ID_SOCKET0_ADDRESS

The reserved parameter ID.

Value Type Description
501 ps_parameter_id Socket 0 address.

PSYNC_PARAM_ID_SOCKET1_PORT

The reserved parameter ID.

Value Type Description
502 ps_parameter_id Socket 1 port number.

PSYNC_PARAM_ID_SOCKET1_ADDRESS

The reserved parameter ID.

Value Type Description
503 ps_parameter_id Socket 1 address.

PSYNC_PARAM_ID_SOCKET2_PORT

The reserved parameter ID.

Value Type Description
504 ps_parameter_id Socket 2 port number.

PSYNC_PARAM_ID_SOCKET2_ADDRESS

The reserved parameter ID.

Value Type Description
505 ps_parameter_id Socket 2 address.

PSYNC_PARAM_ID_SOCKET3_PORT

The reserved parameter ID.

Value Type Description
506 ps_parameter_id Socket 3 port number.

PSYNC_PARAM_ID_SOCKET3_ADDRESS

The reserved parameter ID.

Value Type Description
507 ps_parameter_id Socket 3 address.

PSYNC_PARAM_ID_SOCKET4_PORT

The reserved parameter ID.

Value Type Description
508 ps_parameter_id Socket 4 port number.

PSYNC_PARAM_ID_SOCKET4_ADDRESS

The reserved parameter ID.

Value Type Description
509 ps_parameter_id Socket 4 address.

PSYNC_PARAM_ID_SOCKET5_PORT

The reserved parameter ID.

Value Type Description
510 ps_parameter_id Socket 5 port number.

PSYNC_PARAM_ID_SOCKET5_ADDRESS

The reserved parameter ID.

Value Type Description
511 ps_parameter_id Socket 5 address.

PSYNC_PARAM_ID_SERIAL0_NAME

The reserved parameter ID.

Value Type Description
600 ps_parameter_id Serial device 0 name.

PSYNC_PARAM_ID_SERIAL0_DATARATE

The reserved parameter ID.

Value Type Description
601 ps_parameter_id Serial device 0 datarate.

PSYNC_PARAM_ID_SERIAL1_NAME

The reserved parameter ID.

Value Type Description
602 ps_parameter_id Serial device 1 name.

PSYNC_PARAM_ID_SERIAL1_DATARATE

The reserved parameter ID.

Value Type Description
603 ps_parameter_id Serial device 1 datarate.

PSYNC_PARAM_ID_SERIAL2_NAME

The reserved parameter ID.

Value Type Description
604 ps_parameter_id Serial device 2 name.

PSYNC_PARAM_ID_SERIAL2_DATARATE

The reserved parameter ID.

Value Type Description
605 ps_parameter_id Serial device 2 datarate.

PSYNC_PARAM_ID_SERIAL3_NAME

The reserved parameter ID.

Value Type Description
606 ps_parameter_id Serial device 3 name.

PSYNC_PARAM_ID_SERIAL3_DATARATE

The reserved parameter ID.

Value Type Description
607 ps_parameter_id Serial device 3 datarate.

PSYNC_PARAM_ID_SERIAL4_NAME

The reserved parameter ID.

Value Type Description
608 ps_parameter_id Serial device 4 name.

PSYNC_PARAM_ID_SERIAL4_DATARATE

The reserved parameter ID.

Value Type Description
609 ps_parameter_id Serial device 4 datarate.

PSYNC_PARAM_ID_SERIAL5_NAME

The reserved parameter ID.

Value Type Description
610 ps_parameter_id Serial device 5 name.

PSYNC_PARAM_ID_SERIAL5_DATARATE

The reserved parameter ID.

Value Type Description
611 ps_parameter_id Serial device 5 datarate.

PSYNC_PARAM_ID_COORDINATE_FRAME

The reserved parameter ID.

This will be used to get/set the active parent coordinate frame identifier, usually at the node level.

Value Type Description
800 ps_parameter_id Active coordinate frame identifier.

PSYNC_PARAM_ID_OUTPUT_FOV

The reserved parameter ID. This is the output field of view clipping, usually at the node level. Value is used to indicate the range and inclusive/exclusive properties for the given FOV settings. If value is zero or positive, FOV includes data starting from minimum angle to maximum angle, moving counter-clockwise. If value is negative, FOV includes data starting from minimum angle to maximum angle, moving clockwise.

Value Type Description
810 ps_parameter_id Output field of view range.

PSYNC_PARAM_ID_GPS0_ANTENNA_MOUNT_X

The reserved parameter ID. This is relative to the platform frame.

Value Type Description
900 ps_parameter_id GPS antenna 0 X position.

PSYNC_PARAM_ID_GPS0_ANTENNA_MOUNT_Y

The reserved parameter ID. This is relative to the platform frame.

Value Type Description
901 ps_parameter_id GPS antenna 0 Y position.

PSYNC_PARAM_ID_GPS0_ANTENNA_MOUNT_Z

The reserved parameter ID. This is relative to the platform frame.

Value Type Description
902 ps_parameter_id GPS antenna 0 Z position.

PSYNC_PARAM_ID_GPS1_ANTENNA_MOUNT_X

The reserved parameter ID. This is relative to the platform frame.

Value Type Description
903 ps_parameter_id GPS antenna 1 X position.

PSYNC_PARAM_ID_GPS1_ANTENNA_MOUNT_Y

The reserved parameter ID. This is relative to the platform frame.

Value Type Description
904 ps_parameter_id GPS antenna 1 Y position.

PSYNC_PARAM_ID_GPS1_ANTENNA_MOUNT_Z

The reserved parameter ID. This is relative to the platform frame.

Value Type Description
905 ps_parameter_id GPS antenna 1 Z position.

PSYNC_PARAM_ID_GPS2_ANTENNA_MOUNT_X

The reserved parameter ID. This is relative to the platform frame.

Value Type Description
906 ps_parameter_id GPS antenna 2 X position.

PSYNC_PARAM_ID_GPS2_ANTENNA_MOUNT_Y

The reserved parameter ID. This is relative to the platform frame.

Value Type Description
907 ps_parameter_id GPS antenna 2 Y position.

PSYNC_PARAM_ID_GPS2_ANTENNA_MOUNT_Z

The reserved parameter ID. This is relative to the platform frame.

Value Type Description
908 ps_parameter_id GPS antenna 2 Z position.

PSYNC_PARAM_ID_SENSOR0_TYPE

This is relative to the platform frame.

Value Type Description
1000 ps_parameter_id Sensor 0 identifier.

PSYNC_PARAM_ID_SENSOR0_ID

This is relative to the platform frame.

Value Type Description
1001 ps_parameter_id Sensor 0 identifier.

PSYNC_PARAM_ID_SENSOR0_MOUNT_X

This is relative to the platform frame.

Value Type Description
1002 ps_parameter_id Sensor 0 X position.

PSYNC_PARAM_ID_SENSOR0_MOUNT_Y

This is relative to the platform frame.

Value Type Description
1003 ps_parameter_id Sensor 0 Y position.

PSYNC_PARAM_ID_SENSOR0_MOUNT_Z

This is relative to the platform frame.

Value Type Description
1004 ps_parameter_id Sensor 0 Z position.

PSYNC_PARAM_ID_SENSOR0_MOUNT_ROLL

This is relative to the platform frame.

Value Type Description
1005 ps_parameter_id Sensor 0 roll orientation.

PSYNC_PARAM_ID_SENSOR0_MOUNT_PITCH

This is relative to the platform frame.

Value Type Description
1006 ps_parameter_id Sensor 0 pitch orientation.

PSYNC_PARAM_ID_SENSOR0_MOUNT_YAW

This is relative to the platform frame.

Value Type Description
1007 ps_parameter_id Sensor 0 pitch orientation.

PSYNC_PARAM_ID_SENSOR1_TYPE

This is relative to the platform frame.

Value Type Description
1008 ps_parameter_id Sensor 1 identifier.

PSYNC_PARAM_ID_SENSOR1_ID

This is relative to the platform frame.

Value Type Description
1009 ps_parameter_id Sensor 1 identifier.

PSYNC_PARAM_ID_SENSOR1_MOUNT_X

This is relative to the platform frame.

Value Type Description
1010 ps_parameter_id Sensor 1 X position.

PSYNC_PARAM_ID_SENSOR1_MOUNT_Y

This is relative to the platform frame.

Value Type Description
1011 ps_parameter_id Sensor 1 Y position.

PSYNC_PARAM_ID_SENSOR1_MOUNT_Z

This is relative to the platform frame.

Value Type Description
1012 ps_parameter_id Sensor 1 Z position.

PSYNC_PARAM_ID_SENSOR1_MOUNT_ROLL

This is relative to the platform frame.

Value Type Description
1013 ps_parameter_id Sensor 1 roll orientation.

PSYNC_PARAM_ID_SENSOR1_MOUNT_PITCH

This is relative to the platform frame.

Value Type Description
1014 ps_parameter_id Sensor 1 pitch orientation.

PSYNC_PARAM_ID_SENSOR1_MOUNT_YAW

This is relative to the platform frame.

Value Type Description
1015 ps_parameter_id Sensor 1 pitch orientation.

PSYNC_PARAM_ID_SENSOR2_TYPE

This is relative to the platform frame.

Value Type Description
1016 ps_parameter_id Sensor 2 identifier.

PSYNC_PARAM_ID_SENSOR2_ID

This is relative to the platform frame.

Value Type Description
1017 ps_parameter_id Sensor 2 identifier.

PSYNC_PARAM_ID_SENSOR2_MOUNT_X

This is relative to the platform frame.

Value Type Description
1018 ps_parameter_id Sensor 2 X position.

PSYNC_PARAM_ID_SENSOR2_MOUNT_Y

This is relative to the platform frame.

Value Type Description
1019 ps_parameter_id Sensor 2 Y position.

PSYNC_PARAM_ID_SENSOR2_MOUNT_Z

This is relative to the platform frame.

Value Type Description
1020 ps_parameter_id Sensor 2 Z position.

PSYNC_PARAM_ID_SENSOR2_MOUNT_ROLL

This is relative to the platform frame.

Value Type Description
1021 ps_parameter_id Sensor 2 roll orientation.

PSYNC_PARAM_ID_SENSOR2_MOUNT_PITCH

This is relative to the platform frame.

Value Type Description
1022 ps_parameter_id Sensor 2 pitch orientation.

PSYNC_PARAM_ID_SENSOR2_MOUNT_YAW

This is relative to the platform frame.

Value Type Description
1023 ps_parameter_id Sensor 2 pitch orientation.

PSYNC_PARAM_ID_SENSOR3_TYPE

This is relative to the platform frame.

Value Type Description
1024 ps_parameter_id Sensor 3 identifier.

PSYNC_PARAM_ID_SENSOR3_ID

This is relative to the platform frame.

Value Type Description
1025 ps_parameter_id Sensor 3 identifier.

PSYNC_PARAM_ID_SENSOR3_MOUNT_X

This is relative to the platform frame.

Value Type Description
1026 ps_parameter_id Sensor 3 X position.

PSYNC_PARAM_ID_SENSOR3_MOUNT_Y

This is relative to the platform frame.

Value Type Description
1027 ps_parameter_id Sensor 3 Y position.

PSYNC_PARAM_ID_SENSOR3_MOUNT_Z

This is relative to the platform frame.

Value Type Description
1028 ps_parameter_id Sensor 3 Z position.

PSYNC_PARAM_ID_SENSOR3_MOUNT_ROLL

This is relative to the platform frame.

Value Type Description
1029 ps_parameter_id Sensor 3 roll orientation.

PSYNC_PARAM_ID_SENSOR3_MOUNT_PITCH

This is relative to the platform frame.

Value Type Description
1030 ps_parameter_id Sensor 3 pitch orientation.

PSYNC_PARAM_ID_SENSOR3_MOUNT_YAW

This is relative to the platform frame.

Value Type Description
1031 ps_parameter_id Sensor 3 pitch orientation

PSYNC_PARAM_ID_SENSOR4_TYPE

Relative to the platform frame.

Value Type Description
1032 ps_parameter_id Sensor 4 identifier

PSYNC_PARAM_ID_SENSOR4_ID

This is relative to the platform frame.

Value Type Description
1033 ps_parameter_id Sensor 4 identifier

PSYNC_PARAM_ID_SENSOR4_MOUNT_X

This is relative to the platform frame.

Value Type Description
1034 ps_parameter_id Sensor 4 X position

PSYNC_PARAM_ID_SENSOR4_MOUNT_Y

This is relative to the platform frame.

Value Type Description
1035 ps_parameter_id Sensor 4 Y position

PSYNC_PARAM_ID_SENSOR4_MOUNT_Z

This is relative to the platform frame.

Value Type Description
1036 ps_parameter_id Sensor 4 Z position

PSYNC_PARAM_ID_SENSOR4_MOUNT_ROLL

This is relative to the platform frame.

Value Type Description
1037 ps_parameter_id Sensor 4 roll orientation

PSYNC_PARAM_ID_SENSOR4_MOUNT_PITCH

This is relative to the platform frame.

Value Type Description
1038 ps_parameter_id Sensor 4 pitch orientation

PSYNC_PARAM_ID_SENSOR4_MOUNT_YAW

This is relative to the platform frame.

Value Type Description
1039 ps_parameter_id Sensor 4 pitch orientation

PSYNC_PARAM_ID_SENSOR5_TYPE

This is relative to the platform frame.

Value Type Description
1040 ps_parameter_id Sensor 5 identifier

PSYNC_PARAM_ID_SENSOR5_ID

This is relative to the platform frame.

Value Type Description
1041 ps_parameter_id Sensor 5 identifier

PSYNC_PARAM_ID_SENSOR5_MOUNT_X

This is relative to the platform frame.

Value Type Description
1042 ps_parameter_id Sensor 5 X position

PSYNC_PARAM_ID_SENSOR5_MOUNT_Y

This is relative to the platform frame.

Value Type Description
1043 ps_parameter_id Sensor 5 Y position

PSYNC_PARAM_ID_SENSOR5_MOUNT_Z

This is relative to the platform frame.

Value Type Description
1044 ps_parameter_id Sensor 5 Z position

PSYNC_PARAM_ID_SENSOR5_MOUNT_ROLL

This is relative to the platform frame.

Value Type Description
1045 ps_parameter_id Sensor 5 roll orientation

PSYNC_PARAM_ID_SENSOR5_MOUNT_PITCH

This is relative to the platform frame.

Value Type Description
1046 ps_parameter_id Sensor 5 pitch orientation

PSYNC_PARAM_ID_SENSOR5_MOUNT_YAW

This is relative to the platform frame.

Value Type Description
1047 ps_parameter_id Sensor 5 pitch orientation

PSYNC_PARAM_ID_VIDEO0_NAME

This is relative to the platform frame.

Value Type Description
1080 ps_parameter_id Video device 0 name.

PSYNC_PARAM_ID_VIDEO0_TYPE

This is relative to the platform frame.

Value Type Description
1081 ps_parameter_id Video device 0 type.

PSYNC_PARAM_ID_VIDEO0_FORMAT

This is relative to the platform frame.

Value Type Description
1082 ps_parameter_id Video device 0 source pixel format.

PSYNC_PARAM_ID_VIDEO0_WIDTH

This is relative to the platform frame.

Value Type Description
1083 ps_parameter_id Video device 0 source image width.

PSYNC_PARAM_ID_VIDEO0_HEIGHT

This is relative to the platform frame.

Value Type Description
1084 ps_parameter_id Video device 0 source image height.

PSYNC_PARAM_ID_VIDEO0_FPS

This is relative to the platform frame.

Value Type Description
1085 ps_parameter_id Video device 0 source image frames per second.

PSYNC_PARAM_ID_VIDEO0_XOFFSET

This is relative to the platform frame.

Value Type Description
1086 ps_parameter_id Video device 0 source image X offset.

PSYNC_PARAM_ID_VIDEO0_YOFFSET

This is relative to the platform frame.

Value Type Description
1087 ps_parameter_id Video device 0 source image Y offset.

PSYNC_PARAM_ID_VIDEO0_PUBLISHED_FORMAT

This is relative to the platform frame.

Value Type Description
1088 ps_parameter_id Video device 0 published pixel format.

PSYNC_PARAM_ID_VIDEO0_PUBLISHED_WIDTH

This is relative to the platform frame.

Value Type Description
1089 ps_parameter_id Video device 0 published image width.

PSYNC_PARAM_ID_VIDEO0_PUBLISHED_HEIGHT

This is relative to the platform frame.

Value Type Description
1090 ps_parameter_id Video device 0 published image height.

PSYNC_PARAM_ID_VIDEO0_PUBLISHED_FPS

This is relative to the platform frame.

Value Type Description
1091 ps_parameter_id Video device 0 published image frames per second.

PSYNC_PARAM_ID_VIDEO0_LOGGED_FORMAT

This is relative to the platform frame.

Value Type Description
1092 ps_parameter_id Video device 0 logged image width.

PSYNC_PARAM_ID_VIDEO0_LOGGED_WIDTH

This is relative to the platform frame.

Value Type Description
1093 ps_parameter_id Video device 0 logged image width.

PSYNC_PARAM_ID_VIDEO0_LOGGED_HEIGHT

This is relative to the platform frame.

Value Type Description
1094 ps_parameter_id Video device 0 logged image height.

PSYNC_PARAM_ID_VIDEO0_KU

This is relative to the platform frame.

Value Type Description
1095 ps_parameter_id Video device 0 horizontal focal length.

PSYNC_PARAM_ID_VIDEO0_KV

This is relative to the platform frame.

Value Type Description
1096 ps_parameter_id Video device 0 vertical focal length.

PSYNC_PARAM_ID_VIDEO0_U0

This is relative to the platform frame.

Value Type Description
1097 ps_parameter_id Video device 0 horizontal optical center.

PSYNC_PARAM_ID_VIDEO0_V0

This is relative to the platform frame.

Value Type Description
1098 ps_parameter_id Video device 0 vertical optical center.

PSYNC_PARAM_ID_VIDEO0_FOCAL_LENGTH

This is relative to the platform frame.

Value Type Description
1099 ps_parameter_id Video device 0 focal length.

PSYNC_PARAM_ID_VIDEO0_HORIZONTAL_FLIP

This is relative to the platform frame.

Value Type Description
1100 ps_parameter_id Video device 0 horizontal image flip flag.

PSYNC_PARAM_ID_VIDEO0_VERTICAL_FLIP

This is relative to the platform frame.

Value Type Description
1100 ps_parameter_id Video device 0 vertical image flip flag.

PSYNC_PARAM_ID_VIDEO0_2X2_BINNING

This is relative to the platform frame.

Value Type Description
1102 ps_parameter_id Video device 0 2x2 image binning enabled flag.

PSYNC_PARAM_ID_VIDEO0_SHARED_MEM_QUEUE_KEY

Value Type Description
1103 ps_parameter_id Video device 0 shared memory output queue key.

PSYNC_PARAM_ID_VIDEO0_HORIZONTAL_FOV

This is relative to the platform frame.

Value Type Description
1104 ps_parameter_id Video device 0 horizontal field of view angle.

PSYNC_PARAM_ID_VIDEO0_VERTICAL_FOV

This is relative to the platform frame.

Value Type Description
1105 ps_parameter_id Video device 0 vertical field of view angle.