Return status codes for FX SDK functions.
This enumeration defines common return values used by most API functions to indicate success, generic failures, or specific error conditions.
| Enumerator |
|---|
| FUNC_RET_SUCCESS | Operation completed successfully.
|
| FUNC_RET_OPERATION_FAILED | Generic operation failure.
|
| FUNC_RET_LINK_FAILED | Communication link establishment failed.
|
| FUNC_RET_LINK_NO_RESPONSE | No response received from remote endpoint.
|
| FUNC_RET_VERSION_INCOMPATIABLE | Version mismatch detected.
|
| FUNC_RET_INVALID_INPUT_ARG | Invalid input argument provided.
|
| FUNC_RET_INVALID_CONDITION | Preconditions for operation not satisfied.
|
| FUNC_RET_SEND_FILE_FAILED | File transmission failed.
|
| FUNC_RET_RECV_FILE_FAILED | File reception failed.
|
| FUNC_RET_INVALID_OBJ | Invalid object type specified.
|
| FUNC_RET_OPERATION_TIMEOUT | Operation exceeded allowed time limit.
|
| FUNC_RET_SET_PARAM_FAILED | Failed to set parameter.
|
| FUNC_RET_GET_PARAM_FAILED | Failed to retrieve parameter.
|
| FUNC_RET_SAVE_PARAM_FAILED | Failed to save parameter to storage.
|
| FUNC_RET_INVALID_TERMINAL | Invalid terminal identifier.
|
| FUNC_RET_INVALID_PARAM_SETTING | Invalid parameter configuration.
|
| FUNC_RET_COMM_WAIT_READY_TIMEOUT | Timeout waiting for communication ready state.
|
| FUNC_RET_COMM_SEND_FAILED | Data transmission failed.
|
| FUNC_RET_COMM_WAIT_REPLY_TIMEOUT | Timeout waiting for command reply.
|
| FUNC_RET_FORMAT_CMD_FAILED | Command formatting or construction failed.
|
| FUNC_RET_INVALID_ROBOT_TYPE | Invalid robot type to support.
|
| FUNC_RET_INVALID_HAND_TYPE | Invalid hand type to support.
|
| FUNC_RET_LINK_REJECTED | Controller has already linked by other client.
|
| FUNC_RET_INVALID_THREAD_ID | Invalid thread ID for runtime APIs.
|
| FUNC_RET_TOO_MANY_USER_DATA_ITEM | Too many sample data item registed.
|
| FUNC_RET_INVALID_USER_DATA_ITEM | Invalid sample data item.
|
| FUNC_RET_INVALID_USER_DATA_LEN | Invalid sample data length.
|
| FUNC_RET_KINE_NOT_INITIALIZED | Kinematics context or arm environment is not initialized.
|
| FUNC_RET_KINE_INIT_FAILED | Kinematics environment initialization failed.
|
| FUNC_RET_KINE_TOOL_FAILED | Tool transform update failed.
|
| FUNC_RET_KINE_IK_UNREACHABLE | Inverse kinematics target is unreachable or singular.
|
| FUNC_RET_KINE_IK_JOINT_LIMIT_EXCEEDED | Inverse kinematics result exceeds joint limits.
|
| FUNC_RET_KINE_PLAN_FAILED | Motion planning failed for an unspecified kinematics reason.
|
| FUNC_RET_KINE_PLAN_JOINT_LIMIT | Planned motion exceeds joint limits.
|
| FUNC_RET_KINE_PLAN_UNREACHABLE | Planned Cartesian target is unreachable.
|
| FUNC_RET_KINE_TRAJ_POINT_OVERFLOW | Planned trajectory exceeds the maximum point count.
|
| FUNC_RET_KINE_SYNC_POINT_MISMATCH | Dual-arm synchronized plan produced mismatched point counts.
|
| FUNC_RET_KINE_DYNAMICS_IDENT_FAILED | Dynamics identification failed.
|
| FUNC_RET_KINE_INTERNAL_ERROR | Internal kinematics or planning error.
|
1.17.0