Error codes
This page lists error codes that can be returned from Connection and Communication procedures (see Photoneo robotic API).
The error codes are divided into the following categories:
No error An error code that denotes that the procedure call finished successfully. It can be returned from the Connection and Communication procedures.
General errors from Connection and Communication procedures These errors denote the result of a network-related operation - connection to the Action Request Server, sending an action request, and receiving a response. They can be returned from all network-related API calls - Connection procedures, Synchronous, and Asynchronous action requests, and Response receiving procedures. Note: Please note that the implementation of the TCP communication in the Robot module among respective robotic brands can differ. That can result in different behavior of the Connection procedures and/or the Communication procedures when a network-related issue occurs. Please refer to the integration guide of the specific robot brand for more information.
Errors from action requests These errors denote the result of an action request executed by the Vision Controller. They can be returned from Synchronous action requests and Response-receiving procedures. Note: Scan and Trajectory requests are of asynchronous type - they only send the action request which means they can only return General errors from Connection and Communication procedures. Response-receiving procedures related to these asynchronous action requests return the result of the request executed by the Vision Controller.
General errors from action requests
Errors from Bin picking action requests
Errors from Locator action requests
Errors from Solution action requests
Errors from Calibration action requests
It is highly recommended to perform adequate error handling after each Connection and Communication procedure.
No error (0)
Description / Cause |
Troubleshooting |
|---|---|
The procedure call finished successfully. No error occurred during execution. |
Use this error code to verify the success of the procedure call.
For action requests to which the response contains also other data than the error code (that are stored in global variables/registers), the No error code also confirms the validity of the data. If other than No error code is received, the data is not valid and must not be used!
|
General errors from Connection and Communication procedures
Communication error (3)
Description / Cause |
Troubleshooting |
|---|---|
Could not establish a valid connection to the Action Request Server. |
Ensure the vision controller is booted up. Check the network settings and the connection between the vision controller and the robot. |
Description / Cause |
Troubleshooting |
|---|---|
A communication error occurred during the TCP send/receive operation. |
Check the connection between the vision controller and the robot. If the vision controller is switched off because of power failure, it will automatically boot up when the power is restored. When booted up, a new connection can be established using a connection procedure. |
Bad data (4)
Description / Cause |
Troubleshooting |
|---|---|
Data received from the vision controller in the response to an action request are not valid. |
Check the connection between the vision controller and the robot. If the issue persists, please contact support@photoneo.com. |
Timeout (5)
Description / Cause |
Troubleshooting |
|---|---|
Timeout was reached while trying to connect to the Action Request Server. |
Ensure the vision controller is booted up. Check the network settings and the connection between the vision controller and the robot. |
Description / Cause |
Troubleshooting |
|---|---|
Timeout was reached while trying to send an action request/receive a response. |
Check the connection between the vision controller and the robot. Check the value of the timeout (if applicable). |
General errors from action requests
Service error (1)
Description / Cause |
Troubleshooting |
|---|---|
The process which handles the called action request is not available. |
When calling a bin picking action request, a BPS solution must be deployed (LS solution for locator action requests). Similarly, the calibration must be running in order to call a calibration request. Solution requests are normally callable at any time. |
Brand does not match (7)
Description / Cause |
Troubleshooting |
|---|---|
The brand of the connected robot which sent the action request does not match the brand of the robot which is selected in the solution that is deployed/has calibration running. |
Select the correct robot model in the solution and restart the process (deployment/calibration). |
Bin picking in simulation mode (8)
Description / Cause |
Troubleshooting |
|---|---|
There is a solution deployed in the Simulation mode. No action request sent from the robot is executed. |
Deploy the solution in the Production mode. |
Errors from Bin picking action requests
Unknown error (200)
Description / Cause |
Troubleshooting |
|---|---|
Unhandled state of the bin picking application. |
Please contact support@photoneo.com. |
Path planning failed (201)
Description / Cause |
Troubleshooting |
|---|---|
None of the localized objects had a trajectory successfully computed before the trajectory timeout was reached. |
Check the bin picking statuses of the localized objects. Open the Inspector to find the cause of the path planning failure. Follow instructions in Performance troubleshooting to solve path planning failures. |
No object found (202)
Description / Cause |
Troubleshooting |
|---|---|
No object was localized after the latest scan request. |
If there are objects on the scene, adjust the localization profile parameters to improve the localization performance. Alternatively, tune the scanner settings to achieve better scanning quality. |
Vision system not initialized (203)
Description / Cause |
Troubleshooting |
|---|---|
The vision system for which the scan request was received is not initialized. |
A successful initialization request must be sent before a scan request. |
Empty scene (218)
Description / Cause |
Troubleshooting |
|---|---|
The scene was evaluated as empty because the number of points in the point cloud is less than the defined threshold. Note: Empty scene feature must be enabled. |
If there are still objects on the scene (the scene is not really empty), adjust the defined Empty scene threshold or the bounding box (if used). |
Unknown robot state (219)
Description / Cause |
Troubleshooting |
|---|---|
The point cloud for the hand-eye vision system could not be transformed into robot space because of an unknown robot pose during the scan acquisition. |
A valid connection to the Robot State Server is required for bin picking with hand-eye vision systems. Make sure the Robot State Server is running and the network configuration is correct. |
Scene state not found (220)
Description / Cause |
Troubleshooting |
|---|---|
The scene state for which the action request was received is not defined in the deployed solution. |
Make sure the scene state ID defined in the robotic program matches the ID of the requested scene state in the solution. |
Scene state already active (221)
Description / Cause |
Troubleshooting |
|---|---|
The scene state with the ID provided in the action request is already active. |
Wrong bin picking configuration (255)
This is a cumulative error code that has multiple causes and can be returned from various action requests:
Description / Cause |
Troubleshooting |
|---|---|
The vision system for which the action request was received is not defined in the deployed solution. |
Make sure the vision system ID defined in the robotic program matches the ID of the requested vision system in the solution. |
The start/end pose has an incorrect number of joint values. |
Fix the start/end pose data sent in the initialization request. |
The start/end pose is outside the defined joint limits. |
Adjust the joint limits or the start/end pose to satisfy the joint limits. The deployment console provides information about the particular joint that is outside the joint limits. |
The start/end pose is in a collision. |
Adjust the position of collision objects (if incorrect) or the start/end pose to not be in a colliding state. The deployment console provides information about the pair of elements (a part of the kinematic chain and a collision object) that are in the colliding state. |
The brand of the connected robot which sent the action request does not match the brand of the robot which is selected in the solution that is deployed/has calibration running. |
Select the correct robot model in the solution and restart the deployment. |
There is a solution deployed in the Simulation mode. No action request sent from the robot is executed. |
Deploy the solution in the Production mode. |
Description / Cause |
Troubleshooting |
|---|---|
The vision system for which the action request was received is not defined in the deployed solution. |
Make sure the vision system ID defined in the robotic program matches the ID of the requested vision system in the solution. |
There is a solution deployed in the Simulation mode. No action request sent from the robot is executed. |
Deploy the solution in the Production mode. |
Description / Cause |
Troubleshooting |
|---|---|
The vision system for which the action request was received is not defined in the deployed solution. |
Make sure the vision system ID defined in the robotic program matches the ID of the requested vision system in the solution. |
The vision system for which the trajectory request was received did not capture the most recent successful scan. |
Make sure the trajectory request was sent for the same vision system that captured the last scan and that the scan was successful. |
There is a solution deployed in the Simulation mode. No action request sent from the robot is executed. |
Deploy the solution in the Production mode. |
Description / Cause |
Troubleshooting |
|---|---|
The vision system for which the action request was received is not defined in the deployed solution. |
Make sure the vision system ID defined in the robotic program matches the ID of the requested vision system in the solution. |
There is a solution deployed in the Simulation mode. No action request sent from the robot is executed. |
Deploy the solution in the Production mode. |
Errors from Locator action requests
Vision system not found (500)
Description / Cause |
Troubleshooting |
|---|---|
The vision system for which the action request was received is not defined in the deployed solution. |
Make sure the vision system ID defined in the robotic program matches the ID of the requested vision system in the solution. |
Empty scene (501)
Description / Cause |
Troubleshooting |
|---|---|
The scene was evaluated as empty because the number of points in the point cloud is less than the defined threshold. Note: Empty scene feature must be enabled. |
If there are still objects on the scene (the scene is not really empty), adjust the defined Empty scene threshold or the bounding box (if used). |
No object found, Detection running (502)
Description / Cause |
Troubleshooting |
|---|---|
No object was yet localized after the latest scan request but the localization is still running. |
Call the action request later as the localization did not find any object yet. |
No object found, Detection stopped (503)
Description / Cause |
Troubleshooting |
|---|---|
No object was localized after the latest scan request and the localization is stopped. |
If there are objects on the scene, adjust the localization profile parameters to improve the localization performance. Alternatively, tune the scanner settings to achieve better scanning quality. |
All objects rejected, Detection running (504)
Description / Cause |
Troubleshooting |
|---|---|
All yet localized objects were rejected but the localization is still running. |
Call the action request later as the localization did not find any object yet. |
All objects rejected, Detection stopped (505)
Description / Cause |
Troubleshooting |
|---|---|
All localized objects were rejected and the localization is stopped. |
Check the configuration of the Angle constraint which caused the rejection of object(s). |
Errors from Solution action requests
Wrong bin picking configuration (255)
Note: This is a cumulative error code that has multiple causes and can be returned from all Bin picking action requests and the Change solution request - to ensure backward compatibility with previous versions. Other Solution requests return specific error codes.
Description / Cause |
Troubleshooting |
|---|---|
One of the following errors occurred: 405, 406, 450, 452, 453, 454, 455, 457, 458, 459. |
Please refer to the troubleshooting of the listed errors. |
Invalid solution ID (450)
Description / Cause |
Troubleshooting |
|---|---|
A solution with the ID provided in the action request does not exist. |
Make sure the start solution request was sent with the correct ID. |
Another solution running (451)
Description / Cause |
Troubleshooting |
|---|---|
Cannot start the solution. Another solution is already running. |
Stop the running solution before attempting to start another. Alternatively, use the Change solution request. |
Deployment not started (452)
Description / Cause |
Troubleshooting |
|---|---|
The solution deployment failed. |
One of the following might have occurred:
|
Deployment is not running (453)
Description / Cause |
Troubleshooting |
|---|---|
No solution is currently running. |
To provide a valid response, the action request must be sent while a solution is running in deployment. |
Deployment did not stop (454)
Description / Cause |
Troubleshooting |
|---|---|
The deployment was not stopped successfully. |
Please contact support@photoneo.com. |
Solution is not complete (455)
Description / Cause |
Troubleshooting |
|---|---|
The solution with the ID provided in the action request is not ready for deployment. |
Finish the configuration of the requested solution in order to be able to deploy it. |
Invalid robot brand (457)
Description / Cause |
Troubleshooting |
|---|---|
The solution with the ID provided in the action request has a robot of a different brand selected. |
Make sure you are requesting the correct solution to start. If so, select a robot model of the same brand as the connected robot. |
Solution already running (458)
Description / Cause |
Troubleshooting |
|---|---|
The solution with the ID provided in the action request is already running. |
If the currently running solution needs to be restarted, stop it before attempting to start it again. |
Solution access unauthorized (459)
Description / Cause |
Troubleshooting |
|---|---|
The solution with the ID provided in the request is owned by the admin user and it is not set as Factory default. Such a solution cannot be deployed from the robot. |
Make sure you are requesting the correct solution to start. If so, please contact support@photoneo.com. |
Errors from Calibration action requests
Any error
Description / Cause |
Troubleshooting |
|---|---|
An error occurred while adding a new calibration point. |
The calibration program (robot calibration poses) should be prepared in such a way that no error occurs when adding any of the required calibration points. In case an error is returned from the request it might be possible to repeat the request several times. If the issue persists, the program should be halted. Please check the Calibration page of the Studio to see the detailed description of the error that occurred. |