Classes | Enumerations | Variables
urcl::primary_interface Namespace Reference

Classes

class  AbstractPrimaryConsumer
 Base consumer for primary packages. More...
 
class  ConfigurationData
 The ConfigurationData class handles the configuration data sent via the primary UR interface. More...
 
struct  ErrorCode
 
class  ErrorCodeMessage
 The ErrorCodeMessage class handles the error code messages sent via the primary UR interface. More...
 
class  KinematicsInfo
 This messages contains information about the robot's calibration. The DH parameters are a combination between the perfect model parameters and the correction deltas as noted in the configuration files on the robot controller. More...
 
class  PackageHeader
 This class represents the header for primary packages. More...
 
class  PrimaryClient
 
class  PrimaryConsumer
 Primary consumer implementation. More...
 
class  PrimaryPackage
 The PrimaryPackage is solely an abstraction level. It inherits form the URPackage and is also a parent class for primary_interface::RobotMessage, primary_interface::RobotState. More...
 
class  PrimaryParser
 The primary specific parser. Interprets a given byte stream as serialized primary packages and parses it accordingly. More...
 
class  RobotMessage
 The RobotMessage class is a parent class for the different received robot messages. More...
 
class  RobotModeData
 This messages contains data about the mode of the robot. More...
 
class  RobotState
 Base class for a RobotState data packages will be used directly. More...
 
class  VersionMessage
 The VersionMessage class handles the version messages sent via the primary UR interface. More...
 

Enumerations

enum  ReportLevel : int32_t {
  ReportLevel::DEBUG = 0, ReportLevel::INFO = 1, ReportLevel::WARNING = 2, ReportLevel::VIOLATION = 3,
  ReportLevel::FAULT = 4, ReportLevel::DEVL_DEBUG = 128, ReportLevel::DEVL_INFO = 129, ReportLevel::DEVL_WARNING = 130,
  ReportLevel::DEVL_VIOLATION = 131, ReportLevel::DEVL_FAULT = 132
}
 
enum  RobotMessagePackageType : uint8_t {
  RobotMessagePackageType::ROBOT_MESSAGE_TEXT = 0, RobotMessagePackageType::ROBOT_MESSAGE_PROGRAM_LABEL = 1, RobotMessagePackageType::PROGRAM_STATE_MESSAGE_VARIABLE_UPDATE = 2, RobotMessagePackageType::ROBOT_MESSAGE_VERSION = 3,
  RobotMessagePackageType::ROBOT_MESSAGE_SAFETY_MODE = 5, RobotMessagePackageType::ROBOT_MESSAGE_ERROR_CODE = 6, RobotMessagePackageType::ROBOT_MESSAGE_KEY = 7, RobotMessagePackageType::ROBOT_MESSAGE_REQUEST_VALUE = 9,
  RobotMessagePackageType::ROBOT_MESSAGE_RUNTIME_EXCEPTION = 10
}
 Possible RobotMessage types. More...
 
enum  RobotPackageType : int8_t {
  RobotPackageType::DISCONNECT = -1, RobotPackageType::ROBOT_STATE = 16, RobotPackageType::ROBOT_MESSAGE = 20, RobotPackageType::HMC_MESSAGE = 22,
  RobotPackageType::MODBUS_INFO_MESSAGE = 5, RobotPackageType::SAFETY_SETUP_BROADCAST_MESSAGE = 23, RobotPackageType::SAFETY_COMPLIANCE_TOLERANCES_MESSAGE = 24, RobotPackageType::PROGRAM_STATE_MESSAGE = 25
}
 Possible RobotPackage types. More...
 
enum  RobotStateType : uint8_t {
  RobotStateType::ROBOT_MODE_DATA = 0, RobotStateType::JOINT_DATA = 1, RobotStateType::TOOL_DATA = 2, RobotStateType::MASTERBOARD_DATA = 3,
  RobotStateType::CARTESIAN_INFO = 4, RobotStateType::KINEMATICS_INFO = 5, RobotStateType::CONFIGURATION_DATA = 6, RobotStateType::FORCE_MODE_DATA = 7,
  RobotStateType::ADDITIONAL_INFO = 8, RobotStateType::CALIBRATION_DATA = 9
}
 Possible RobotState types. More...
 

Variables

static const int UR_PRIMARY_PORT = 30001
 
static const int UR_SECONDARY_PORT = 30002
 

Enumeration Type Documentation

◆ ReportLevel

enum urcl::primary_interface::ReportLevel : int32_t
strong
Enumerator
DEBUG 
INFO 
WARNING 
VIOLATION 
FAULT 
DEVL_DEBUG 
DEVL_INFO 
DEVL_WARNING 
DEVL_VIOLATION 
DEVL_FAULT 

Definition at line 37 of file error_code_message.h.

◆ RobotMessagePackageType

Possible RobotMessage types.

Enumerator
ROBOT_MESSAGE_TEXT 
ROBOT_MESSAGE_PROGRAM_LABEL 
PROGRAM_STATE_MESSAGE_VARIABLE_UPDATE 
ROBOT_MESSAGE_VERSION 
ROBOT_MESSAGE_SAFETY_MODE 
ROBOT_MESSAGE_ERROR_CODE 
ROBOT_MESSAGE_KEY 
ROBOT_MESSAGE_REQUEST_VALUE 
ROBOT_MESSAGE_RUNTIME_EXCEPTION 

Definition at line 41 of file robot_message.h.

◆ RobotPackageType

Possible RobotPackage types.

Enumerator
DISCONNECT 
ROBOT_STATE 
ROBOT_MESSAGE 
HMC_MESSAGE 
MODBUS_INFO_MESSAGE 
SAFETY_SETUP_BROADCAST_MESSAGE 
SAFETY_COMPLIANCE_TOLERANCES_MESSAGE 
PROGRAM_STATE_MESSAGE 

Definition at line 47 of file primary/package_header.h.

◆ RobotStateType

Possible RobotState types.

Enumerator
ROBOT_MODE_DATA 
JOINT_DATA 
TOOL_DATA 
MASTERBOARD_DATA 
CARTESIAN_INFO 
KINEMATICS_INFO 
CONFIGURATION_DATA 
FORCE_MODE_DATA 
ADDITIONAL_INFO 
CALIBRATION_DATA 

Definition at line 42 of file robot_state.h.

Variable Documentation

◆ UR_PRIMARY_PORT

const int urcl::primary_interface::UR_PRIMARY_PORT = 30001
static

Definition at line 42 of file primary/package_header.h.

◆ UR_SECONDARY_PORT

const int urcl::primary_interface::UR_SECONDARY_PORT = 30002
static

Definition at line 43 of file primary/package_header.h.



ur_client_library
Author(s): Thomas Timm Andersen, Simon Rasmussen, Felix Exner, Lea Steffen, Tristan Schnell
autogenerated on Mon May 26 2025 02:35:58