UnderAutomation
有问题吗?

[email protected]

联系我们
UnderAutomation
⌘Q
本页面仅提供英文版本。

Which protocol for which task

Routes of each robot brand, what each one needs on the controller, and the protocols used by each method of the common API, in the default order.

  • Prerequisites
  • How to read the tables
  • Routes of each brand
  • Fanuc
  • Yaskawa
  • Universal Robots
  • ABB
  • Stubli
  • Routes of each method
  • Information
  • State
  • Programs
  • Debug
  • Variables
  • Inputs and outputs
  • Alarms
  • Motion
  • Files
  • Pendant
  • What to read next

This page lists the routes of each robot brand and the protocols that each method of the common API uses, on Fanuc, Yaskawa, Universal Robots, ABB and Stäubli controllers. Use it to know which interface and which controller option a task needs, and which name to give in the routing settings.

Prerequisites

  • None to read this page. Every table is generated from the route data of the library: it follows the version of the library.
  • The page Routing explains how the library chooses a route at Connect.

How to read the tables

  • A route is a protocol of the controller, sometimes in a given mode. Its name is the value to give to Prefer and Set, or in the text form of the settings. The name of its protocol is the value to give to Forbid. The tables of the methods show the name of the protocol. The name to give in the settings is in the Route column of the tables of the brands. See Routing settings.
  • The routes of a method are listed in the default order of the brand. The first route whose protocol answers at Connect is used. The next ones are fallbacks.
  • (manual) marks a route that the library never opens by itself: you enable it in the connection parameters.
  • "Not available" means that the brand has no route for the method: the method throws FeatureNotSupportedException, and IsAvailable returns false.
  • "n of m" is the number of methods of the service that have a route on the brand.

Routes of each brand

Each table gives the routes of a brand, what each one needs on the controller, and the number of methods that use it as their first route, or have it in their list.

Fanuc

Routes of Fanuc, in the default order of the brand.
RouteProtocolWhat it is and what it needsMethods where it is firstMethods where it is listed
CgtpCgtpWeb server of the controller (CGTP). Firmware 8.30 or later, most methods from 9.10. No controller option.3140
CgtpKclCgtpKCL commands sent to the web server of the controller. Firmware 8.30 or later, some commands from 9.30. No controller option.1018
TelnetKclTelnetKCL commands over Telnet. For old firmware. Needs the Telnet KCL password.018
SnpxSnpxSNPX. Needs the controller option R553 HMI Device (or R650 FRA with R651 FRL). Fast access to registers, signals, alarms and positions.1124
FtpFtpFTP server of the controller: files, diagnostic files, alarm history.1625
RmiRmiRemote Motion Interface (RMI). Needs the controller option R912. Takes the motion control of the controller: never opened automatically. (manual)811

Yaskawa

Routes of Yaskawa, in the default order of the brand.
RouteProtocolWhat it is and what it needsMethods where it is firstMethods where it is listed
HighSpeedEServerHighSpeedEServerHigh Speed Ethernet Server. Function of the controller, enabled in its network settings.4253
FtpFtpFTP server of the controller: files and jobs. The FTP function of the controller must be enabled.1213
HttpHttpWeb server of the controller: list and read of the files.05
EServerEServerHost Control commands over the Ethernet Server.033

Universal Robots

Routes of Universal Robots, in the default order of the brand.
RouteProtocolWhat it is and what it needsMethods where it is firstMethods where it is listed
DashboardDashboardDashboard Server: programs, power, robot mode, safety status. PolyScope 5 (CB3 and e-Series).1517
RestRestREST API of PolyScope X: power and programs.09
PrimaryPrimaryInterfacePrimary Interface: robot state, global variables, breakpoints, step, kinematics information.816
ScriptPrimaryInterfaceURScript sent by the Primary Interface. The program that runs on the robot stops.77
InterpreterModeInterpreterModeURScript sent to the Interpreter Mode. The interpreter program must run on the robot. Never opened automatically. (manual)410
RtdeRtdeReal-Time Data Exchange: positions and signals.33
SftpSftpSFTP: programs and files. Needs the SSH user and password.1515

ABB

Routes of ABB, in the default order of the brand.
RouteProtocolWhat it is and what it needsMethods where it is firstMethods where it is listed
RwsRwsRobot Web Services (RWS): HTTP or HTTPS, user and password of the controller.6060

On ABB, the moves also need one RAPID module, UnderAutomationMotion.mod, loaded once in the motion task of the robot. See Routing.

Stäubli

Routes of Stäubli, in the default order of the brand.
RouteProtocolWhat it is and what it needsMethods where it is firstMethods where it is listed
SoapSoapSOAP server of the controller: user and password of the controller.2626
FileFileFiles of the controller: FTP server of a real controller, or folder of the .controller file of a controller emulated by Stäubli Robotics Suite.1415

Routes of each method

One table per service. Each cell gives the routes of the method on the brand, in the default order.

Information

Identity of the controller and motion groups. See Info.

Information
MethodFanucYaskawaUniversal RobotsABBStäubli
Info.ReadCGTP (Cgtp), FTPHigh Speed Ethernet ServerDashboard ServerRobot Web ServicesSOAP
Info.ReadGroupsCGTP (Cgtp), FTPHigh Speed Ethernet ServerDashboard ServerRobot Web ServicesSOAP
Info2 of 22 of 22 of 22 of 22 of 2

State

State of the controller and servo power. See State.

State
MethodFanucYaskawaUniversal RobotsABBStäubli
State.ReadSNPX, FTPHigh Speed Ethernet Server, Ethernet ServerDashboard Server, Primary Interface (Primary)Robot Web ServicesNot available
State.ServoOnCGTP (CgtpKcl), Telnet, SNPX, RMI (manual)High Speed Ethernet Server, Ethernet ServerDashboard Server, REST API, Primary Interface (Primary)Robot Web ServicesSOAP
State.ServoOffNot availableHigh Speed Ethernet Server, Ethernet ServerDashboard Server, REST API, Primary Interface (Primary)Robot Web ServicesSOAP
State2 of 33 of 33 of 33 of 32 of 3

Programs

List, select, start, pause and stop the programs, and read and write their positions. See Program.

Programs
MethodFanucYaskawaUniversal RobotsABBStäubli
Program.ListCGTP (Cgtp), FTPHigh Speed Ethernet Server, Ethernet Server, FTPSFTPRobot Web ServicesSOAP, Files
Program.SelectCGTP (Cgtp)High Speed Ethernet Server, Ethernet ServerDashboard Server, REST APIRobot Web ServicesSOAP
Program.StartCGTP (Cgtp), CGTP (CgtpKcl), TelnetHigh Speed Ethernet Server, Ethernet ServerDashboard Server, REST APIRobot Web ServicesSOAP
Program.PauseCGTP (Cgtp), CGTP (CgtpKcl), TelnetHigh Speed Ethernet Server, Ethernet ServerDashboard Server, REST APIRobot Web ServicesSOAP
Program.ResumeCGTP (CgtpKcl), TelnetHigh Speed Ethernet Server, Ethernet ServerDashboard Server, REST APIRobot Web ServicesSOAP
Program.StopCGTP (Cgtp), CGTP (CgtpKcl), TelnetNot availableDashboard Server, REST APIRobot Web ServicesSOAP
Program.ReadExecutionSNPX, CGTP (CgtpKcl), Telnet, FTPHigh Speed Ethernet Server, Ethernet ServerDashboard Server, REST APIRobot Web ServicesSOAP
Program.HoldCGTP (CgtpKcl), TelnetHigh Speed Ethernet Server, Ethernet ServerNot availableNot availableNot available
Program.SetCycleModeNot availableHigh Speed Ethernet Server, Ethernet ServerNot availableRobot Web ServicesNot available
Program.SelectAtLineCGTP (Cgtp)High Speed Ethernet Server, Ethernet ServerNot availableRobot Web ServicesNot available
Program.StartAtLineCGTP (Cgtp)High Speed Ethernet Server, Ethernet ServerNot availableRobot Web ServicesNot available
Program.StopTaskCGTP (Cgtp), CGTP (CgtpKcl), TelnetNot availableNot availableNot availableSOAP
Program.Position.ReadFTP, CGTP (Cgtp)FTP, High Speed Ethernet ServerNot availableRobot Web ServicesNot available
Program.Position.WriteCGTP (Cgtp)Not availableNot availableRobot Web ServicesNot available
Program.Position.SetToCurrentCGTP (Cgtp)Not availableNot availableRobot Web ServicesNot available
Program14 of 1511 of 157 of 1513 of 158 of 15

Debug

Breakpoints and step by step execution. See Debug.

Debug
MethodFanucYaskawaUniversal RobotsABBStäubli
Debug.AddBreakpointCGTP (CgtpKcl), TelnetNot availablePrimary Interface (Primary)Robot Web ServicesNot available
Debug.RemoveBreakpointCGTP (CgtpKcl), TelnetNot availablePrimary Interface (Primary)Not availableNot available
Debug.ReadBreakpointsCGTP (CgtpKcl), TelnetNot availableNot availableRobot Web ServicesNot available
Debug.SetStepModeCGTP (CgtpKcl), TelnetHigh Speed Ethernet Server, Ethernet ServerPrimary Interface (Primary)Robot Web ServicesNot available
Debug.ContinueCGTP (CgtpKcl), TelnetHigh Speed Ethernet Server, Ethernet ServerPrimary Interface (Primary)Robot Web ServicesNot available
Debug.SetTaskStepModeCGTP (CgtpKcl), TelnetNot availableNot availableNot availableNot available
Debug.ContinueTaskCGTP (CgtpKcl), TelnetNot availableNot availableNot availableNot available
Debug7 of 72 of 74 of 74 of 70 of 7

Variables

Read and write the variables and registers of the controller. See Variable.

Variables
MethodFanucYaskawaUniversal RobotsABBStäubli
Variable.ReadCGTP (Cgtp), SNPXHigh Speed Ethernet Server, Ethernet ServerDashboard Server, Primary Interface (Primary)Robot Web ServicesNot available
Variable.WriteIntegerCGTP (Cgtp), SNPXHigh Speed Ethernet Server, Ethernet ServerInterpreter Mode (manual)Robot Web ServicesNot available
Variable.WriteRealCGTP (Cgtp), SNPXHigh Speed Ethernet Server, Ethernet ServerInterpreter Mode (manual)Robot Web ServicesNot available
Variable.WriteStringCGTP (Cgtp), SNPXHigh Speed Ethernet Server, Ethernet ServerInterpreter Mode (manual)Robot Web ServicesNot available
Variable.WriteBooleanCGTP (Cgtp), SNPXHigh Speed Ethernet Server, Ethernet ServerInterpreter Mode (manual)Robot Web ServicesNot available
Variable.ReadPositionCGTP (Cgtp), SNPXNot availableNot availableRobot Web ServicesNot available
Variable.WritePositionCGTP (Cgtp), SNPXNot availableNot availableRobot Web ServicesNot available
Variable.ReadCommentCGTP (Cgtp), SNPXHigh Speed Ethernet ServerNot availableNot availableNot available
Variable.WriteCommentCGTP (Cgtp), SNPXHigh Speed Ethernet ServerNot availableNot availableNot available
Variable.ListCGTP (Cgtp)High Speed Ethernet ServerPrimary Interface (Primary)Robot Web ServicesNot available
Variable.ReadManyCGTP (Cgtp), SNPXHigh Speed Ethernet Server, Ethernet ServerNot availableNot availableNot available
Variable11 of 119 of 116 of 118 of 110 of 11

Inputs and outputs

Read, write and simulate the signals. See Io.

Inputs and outputs
MethodFanucYaskawaUniversal RobotsABBStäubli
Io.ReadSNPX, CGTP (Cgtp)High Speed Ethernet Server, Ethernet ServerRTDE, Primary Interface (Primary)Robot Web ServicesSOAP
Io.WriteBooleanSNPX, CGTP (Cgtp), CGTP (CgtpKcl), TelnetHigh Speed Ethernet Server, Ethernet ServerPrimary Interface (Script), Interpreter Mode (manual)Robot Web ServicesSOAP
Io.WriteNumberSNPX, CGTP (Cgtp), CGTP (CgtpKcl), TelnetHigh Speed Ethernet Server, Ethernet ServerPrimary Interface (Script), Interpreter Mode (manual)Robot Web ServicesSOAP
Io.ReadCommentCGTP (Cgtp), SNPXHigh Speed Ethernet ServerNot availableNot availableNot available
Io.WriteCommentCGTP (Cgtp), SNPXHigh Speed Ethernet ServerNot availableNot availableNot available
Io.ListCGTP (Cgtp)High Speed Ethernet ServerNot availableRobot Web ServicesSOAP
Io.ReadManySNPX, CGTP (Cgtp)High Speed Ethernet Server, Ethernet ServerNot availableNot availableSOAP
Io.SimulateCGTP (Cgtp)Not availableNot availableNot availableNot available
Io.UnsimulateCGTP (Cgtp)Not availableNot availableNot availableNot available
Io9 of 97 of 93 of 94 of 95 of 9

Alarms

Active alarms, alarm history and reset. See Alarm.

Alarms
MethodFanucYaskawaUniversal RobotsABBStäubli
Alarm.ReadActiveSNPX, FTPHigh Speed Ethernet Server, Ethernet ServerPrimary Interface (Primary), Dashboard ServerRobot Web ServicesNot available
Alarm.ReadHistorySNPX, FTPNot availableNot availableRobot Web ServicesNot available
Alarm.ResetSNPX, CGTP (CgtpKcl), TelnetHigh Speed Ethernet Server, Ethernet ServerDashboard ServerNot availableNot available
Alarm3 of 32 of 32 of 32 of 30 of 3

Motion

Positions, kinematics, frames and moves. See Motion.

Motion
MethodFanucYaskawaUniversal RobotsABBStäubli
Motion.ReadPoseSNPX, CGTP (Cgtp), RMI (manual), FTPHigh Speed Ethernet Server, Ethernet ServerRTDE, Primary Interface (Primary)Robot Web ServicesSOAP
Motion.ReadJointsSNPX, CGTP (Cgtp), RMI (manual), FTPNot availableRTDE, Primary Interface (Primary)Robot Web ServicesSOAP
Motion.ForwardKinematicsCGTP (Cgtp)Not availablePrimary Interface (Primary)Robot Web ServicesSOAP
Motion.InverseKinematicsCGTP (Cgtp)Not availablePrimary Interface (Primary)Robot Web ServicesSOAP
Motion.ReadUserFrameRMI (manual)Not availableNot availableNot availableNot available
Motion.ReadToolRMI (manual)Not availableNot availableNot availableNot available
Motion.MoveJointRMI (manual)Not availablePrimary Interface (Script), Interpreter Mode (manual)Robot Web ServicesSOAP
Motion.MoveJointToPoseRMI (manual)High Speed Ethernet Server, Ethernet ServerPrimary Interface (Script), Interpreter Mode (manual)Robot Web ServicesSOAP
Motion.MoveLinearRMI (manual)High Speed Ethernet Server, Ethernet ServerPrimary Interface (Script), Interpreter Mode (manual)Robot Web ServicesSOAP
Motion.MoveLinearToJointsRMI (manual)Not availablePrimary Interface (Script), Interpreter Mode (manual)Robot Web ServicesSOAP
Motion.StopMotionRMI (manual)High Speed Ethernet Server, Ethernet ServerPrimary Interface (Script), Dashboard ServerRobot Web ServicesSOAP
Motion.WaitForMotionEndRMI (manual)High Speed Ethernet Server, Ethernet ServerDashboard Server, Primary Interface (Primary)Robot Web ServicesNot available
Motion.ForwardKinematicsInFrameCGTP (Cgtp)Not availableNot availableNot availableNot available
Motion.ReadKinematicModelFTPHigh Speed Ethernet ServerNot availableNot availableNot available
Motion14 of 146 of 1410 of 1410 of 149 of 14

Files

List, download and upload the files of the controller. See File.

Files
MethodFanucYaskawaUniversal RobotsABBStäubli
File.ListFTP, CGTP (Cgtp)FTP, High Speed Ethernet Server, HTTPSFTPRobot Web ServicesFiles
File.DownloadFTPFTP, High Speed Ethernet Server, HTTPSFTPRobot Web ServicesFiles
File.ReadBytesFTPFTP, High Speed Ethernet Server, HTTPSFTPRobot Web ServicesFiles
File.ReadTextFTP, CGTP (Cgtp)FTP, High Speed Ethernet Server, HTTPSFTPRobot Web ServicesFiles
File.UploadFTPFTP, High Speed Ethernet ServerSFTPRobot Web ServicesFiles
File.WriteBytesFTPFTP, High Speed Ethernet ServerSFTPRobot Web ServicesFiles
File.WriteTextFTPFTP, High Speed Ethernet ServerSFTPRobot Web ServicesFiles
File.DeleteFTPFTP, High Speed Ethernet ServerSFTPRobot Web ServicesFiles
File.ExistsFTPFTPSFTPRobot Web ServicesFiles
File.RenameFTPNot availableSFTPRobot Web ServicesFiles
File.CreateDirectoryFTPNot availableSFTPRobot Web ServicesFiles
File.DeleteDirectoryFTPNot availableSFTPRobot Web ServicesFiles
File.ReadBytesWithProgressFTPFTP, High Speed Ethernet Server, HTTPSFTPRobot Web ServicesFiles
File.WriteBytesWithProgressFTPFTP, High Speed Ethernet ServerSFTPRobot Web ServicesFiles
File14 of 1411 of 1414 of 1414 of 1414 of 14

Pendant

Messages on the teach pendant. See Pendant.

Pendant
MethodFanucYaskawaUniversal RobotsABBStäubli
Pendant.ShowMessageNot availableHigh Speed Ethernet Server, Ethernet ServerDashboard Server, REST APINot availableNot available
Pendant0 of 11 of 11 of 10 of 10 of 1

What to read next

  • Routing settings: prefer, set or forbid a route, and enable a manual route.
  • Routing: the route explorer, and the route chosen on your controller.
  • Errors: what to do when a method has no usable route.