#include <visp3/robot/vpRobotKinova.h>

Inheritance diagram for vpRobotKinova:

Public Types
enum	CommandLayer { CMD_LAYER_USB, CMD_LAYER_ETHERNET, CMD_LAYER_UNSET }

enum	vpRobotStateType { STATE_STOP, STATE_VELOCITY_CONTROL, STATE_POSITION_CONTROL, STATE_ACCELERATION_CONTROL, STATE_FORCE_TORQUE_CONTROL }

enum	vpControlFrameType { REFERENCE_FRAME, ARTICULAR_FRAME, JOINT_STATE = ARTICULAR_FRAME, END_EFFECTOR_FRAME, CAMERA_FRAME, TOOL_FRAME = CAMERA_FRAME, MIXT_FRAME }

Public Member Functions
	vpRobotKinova ()

virtual	~vpRobotKinova ()

int	connect ()

void	get_eJe (vpMatrix &eJe)

void	get_fJe (vpMatrix &fJe)

vpHomogeneousMatrix	get_eMc () const

int	getActiveDevice () const

int	getNumDevices () const

void	getDisplacement (const vpRobot::vpControlFrameType frame, vpColVector &q)

void	getPosition (const vpRobot::vpControlFrameType frame, vpColVector &position)

void	getPosition (const vpRobot::vpControlFrameType frame, vpPoseVector &pose)

void	homing ()

void	set_eMc (vpHomogeneousMatrix &eMc)

void	setActiveDevice (int device)

void	setCommandLayer (CommandLayer command_layer)

void	setDoF (unsigned int dof)

void	setPosition (const vpRobot::vpControlFrameType frame, const vpColVector &q)

void	setPluginLocation (const std::string &plugin_location)

void	setVelocity (const vpRobot::vpControlFrameType frame, const vpColVector &vel)

void	setVerbose (bool verbose)

Inherited functionalities from vpRobot
double	getMaxTranslationVelocity (void) const

double	getMaxRotationVelocity (void) const

vpColVector	getPosition (const vpRobot::vpControlFrameType frame)

virtual vpRobotStateType	getRobotState (void) const

void	setMaxRotationVelocity (double maxVr)

void	setMaxTranslationVelocity (double maxVt)

virtual vpRobotStateType	setRobotState (const vpRobot::vpRobotStateType newState)

Static Public Member Functions
Static Public Member Functions inherited from vpRobot
static vpColVector	saturateVelocities (const vpColVector &v_in, const vpColVector &v_max, bool verbose=false)

Protected Member Functions
void	closePlugin ()

void	getJointPosition (vpColVector &q)

void	init ()

void	loadPlugin ()

void	setCartVelocity (const vpRobot::vpControlFrameType frame, const vpColVector &v)

void	setJointVelocity (const vpColVector &qdot)

Protected Member Functions Inherited from vpRobot
vpControlFrameType	setRobotFrame (vpRobot::vpControlFrameType newFrame)

vpControlFrameType	getRobotFrame (void) const

Protected Attributes
vpHomogeneousMatrix	m_eMc

std::string	m_plugin_location

bool	m_verbose

bool	m_plugin_loaded

int	m_devices_count

KinovaDevice *	m_devices_list

int	m_active_device

CommandLayer	m_command_layer

double	maxTranslationVelocity

double	maxRotationVelocity

int	nDof

vpMatrix	eJe

int	eJeAvailable

vpMatrix	fJe

int	fJeAvailable

int	areJointLimitsAvailable

double *	qmin

double *	qmax

bool	verbose_

Static Protected Attributes
static const double	maxTranslationVelocityDefault = 0.2

static const double	maxRotationVelocityDefault = 0.7

Detailed Description

Interface for Kinova Jaco2 robot.

This class is a wrapper over Kinova Jaco SDK that could be downloaded from Kinova Robotics software resources by following the link under Gen2 7 DoF > SDK 1.5.1.

It allows to control Kinova Jaco2 robot Gen 2 with 7 DoF, 6 DoF and 4 DoF.

To select the degrees of freedom corresponding to your robot use setDoF().

Examples:: servoKinovaJacoCart.cpp, and servoKinovaJacoJoint.cpp.

Definition at line 91 of file vpRobotKinova.h.

Member Enumeration Documentation

◆ CommandLayer

enum vpRobotKinova::CommandLayer

Enumerator
CMD_LAYER_USB
CMD_LAYER_ETHERNET
CMD_LAYER_UNSET

Definition at line 94 of file vpRobotKinova.h.

◆ vpControlFrameType

enum vpRobot::vpControlFrameType

inherited

Robot control frames.

Enumerator
REFERENCE_FRAME	Corresponds to a fixed reference frame attached to the robot structure.
ARTICULAR_FRAME	Corresponds to the joint state. This value is deprecated. You should rather use vpRobot::JOINT_STATE.
JOINT_STATE	Corresponds to the joint state.
END_EFFECTOR_FRAME	Corresponds to robot end-effector frame.
CAMERA_FRAME	Corresponds to a frame attached to the camera mounted on the robot end-effector.
TOOL_FRAME	Corresponds to a frame attached to the tool (camera, gripper...) mounted on the robot end-effector. This value is equal to vpRobot::CAMERA_FRAME.
MIXT_FRAME	Corresponds to a "virtual" frame where translations are expressed in the reference frame, and rotations in the camera frame.

Definition at line 75 of file vpRobot.h.

◆ vpRobotStateType

enum vpRobot::vpRobotStateType

inherited

Robot control states.

Enumerator
STATE_STOP	Stops robot motion especially in velocity and acceleration control.
STATE_VELOCITY_CONTROL	Initialize the velocity controller.
STATE_POSITION_CONTROL	Initialize the position controller.
STATE_ACCELERATION_CONTROL	Initialize the acceleration controller.
STATE_FORCE_TORQUE_CONTROL	Initialize the force/torque controller.

Definition at line 64 of file vpRobot.h.

Constructor & Destructor Documentation

◆ vpRobotKinova()

vpRobotKinova::vpRobotKinova ( )

Default constructor that consider a 6 DoF Jaco arm. Use setDoF() to change the degrees of freedom.

Definition at line 57 of file vpRobotKinova.cpp.

References init().

◆ ~vpRobotKinova()

vpRobotKinova::~vpRobotKinova ( )

virtual

Destructor.

Definition at line 67 of file vpRobotKinova.cpp.

References closePlugin(), and m_devices_list.

Member Function Documentation

◆ closePlugin()

void vpRobotKinova::closePlugin ( )

protected

Close plugin.

Definition at line 767 of file vpRobotKinova.cpp.

References m_plugin_loaded, and m_verbose.

Referenced by loadPlugin(), and ~vpRobotKinova().

◆ connect()

int vpRobotKinova::connect ( )

Connect to Kinova devices.

Returns: Number of devices that are connected.

Examples:: servoKinovaJacoCart.cpp, and servoKinovaJacoJoint.cpp.

Definition at line 804 of file vpRobotKinova.cpp.

References vpException::fatalError, loadPlugin(), m_devices_count, m_devices_list, m_plugin_loaded, m_verbose, and setActiveDevice().

◆ get_eJe()

void vpRobotKinova::get_eJe ( vpMatrix & eJe )

virtual

Get the robot Jacobian expressed in the end-effector frame. This function is not implemented. In fact, we don't need it since we can control the robot in cartesian in end-effector frame.

Parameters

[out] eJe : End-effector frame Jacobian.

Implements vpRobot.

Definition at line 123 of file vpRobotKinova.cpp.

References vpException::fatalError, m_devices_count, and m_plugin_loaded.

◆ get_eMc()

vpHomogeneousMatrix vpRobotKinova::get_eMc ( ) const

inline

Return constant transformation between end-effector and tool frame. If your tool is a camera, this transformation is obtained by hand-eye calibration.

Definition at line 112 of file vpRobotKinova.h.

◆ get_fJe()

void vpRobotKinova::get_fJe ( vpMatrix & fJe )

virtual

Get the robot Jacobian expressed in the robot reference frame. This function is not implemented. In fact, we don't need it since we can control the robot in cartesian in end-effector frame.

Parameters

[out] fJe : Base (or reference) frame Jacobian.

Implements vpRobot.

Definition at line 143 of file vpRobotKinova.cpp.

References vpException::fatalError, m_devices_count, and m_plugin_loaded.

◆ getActiveDevice()

int vpRobotKinova::getActiveDevice ( ) const

inline

Definition at line 114 of file vpRobotKinova.h.

◆ getDisplacement()

void vpRobotKinova::getDisplacement	(	const vpRobot::vpControlFrameType	frame,
		vpColVector &	q
	)

virtual

Get a displacement.

Parameters

[in]	frame	: Considered cartesian frame or joint state.
[out]	q	: Displacement in meter and rad.

Implements vpRobot.

Definition at line 671 of file vpRobotKinova.cpp.

References vpException::fatalError, m_devices_count, and m_plugin_loaded.

◆ getJointPosition()

void vpRobotKinova::getJointPosition ( vpColVector & q )

protected

Get robot joint positions.

Warning: We consider here that the robot has only 6 dof, but from the Jaco SDK it could be 7. Should be improved.

Parameters

[in] q : Joint position in rad.

Definition at line 440 of file vpRobotKinova.cpp.

References vpException::fatalError, vpRobot::nDof, vpMath::rad(), and vpColVector::resize().

Referenced by getPosition().

◆ getMaxRotationVelocity()

double vpRobot::getMaxRotationVelocity ( void ) const

inherited

Get the maximal rotation velocity that can be sent to the robot during a velocity control.

Returns: Maximum rotation velocity expressed in rad/s.

Definition at line 273 of file vpRobot.cpp.

References vpRobot::maxRotationVelocity.

Referenced by vpSimulatorAfma6::computeArticularVelocity(), vpSimulatorViper850::computeArticularVelocity(), vpSimulatorAfma6::findHighestPositioningSpeed(), vpSimulatorViper850::findHighestPositioningSpeed(), vpSimulatorAfma6::setPosition(), vpRobotTemplate::setVelocity(), vpSimulatorCamera::setVelocity(), vpRobotCamera::setVelocity(), vpSimulatorPioneer::setVelocity(), vpRobotPioneer::setVelocity(), vpSimulatorPioneerPan::setVelocity(), setVelocity(), vpRobotFlirPtu::setVelocity(), vpSimulatorAfma6::setVelocity(), vpSimulatorViper850::setVelocity(), vpRobotAfma4::setVelocity(), vpRobotAfma6::setVelocity(), vpRobotFranka::setVelocity(), vpRobotViper650::setVelocity(), and vpRobotViper850::setVelocity().

◆ getMaxTranslationVelocity()

double vpRobot::getMaxTranslationVelocity ( void ) const

inherited

Get the maximal translation velocity that can be sent to the robot during a velocity control.

Returns: Maximum translational velocity expressed in m/s.

Definition at line 251 of file vpRobot.cpp.

References vpRobot::maxTranslationVelocity.

Referenced by vpSimulatorAfma6::setPosition(), vpRobotTemplate::setVelocity(), vpSimulatorCamera::setVelocity(), vpRobotCamera::setVelocity(), vpSimulatorPioneer::setVelocity(), vpRobotPioneer::setVelocity(), vpSimulatorPioneerPan::setVelocity(), setVelocity(), vpRobotFlirPtu::setVelocity(), vpSimulatorAfma6::setVelocity(), vpSimulatorViper850::setVelocity(), vpRobotAfma4::setVelocity(), vpRobotAfma6::setVelocity(), vpRobotFranka::setVelocity(), vpRobotViper650::setVelocity(), and vpRobotViper850::setVelocity().

◆ getNumDevices()

int vpRobotKinova::getNumDevices ( ) const

inline

Definition at line 115 of file vpRobotKinova.h.

References vpRobot::getDisplacement(), and vpRobot::getPosition().

◆ getPosition() [1/3]

void vpRobotKinova::getPosition	(	const vpRobot::vpControlFrameType	frame,
		vpColVector &	position
	)

virtual

Get robot position.

Parameters

[in]	frame	: Considered cartesian frame or joint state.
[out]	position	: Either joint or cartesian position. When `frame` is set to vpRobot::JOINT_STATE, `position` contains joint angles expressed in rad, while when `frame` is set to vpRobot::END_EFFECTOR_FRAME `position` contains the cartesian position of the end-effector in the robot base frame as a 6-dim vector, with first the 3 translations expressed in meter, and then the 3 Euler rotations Rxyz expressed in radians.

The following code shows how to use this fonction and convert the resulting position into an homogeneous matrix that gives the transformation between the robot base frame and the end-effector:

vpColVector position;
...
robot.getPosition(vpRobot::END_EFFECTOR_FRAME, position);
vpTranslationVector wte; // reference frame to end-effector frame translations
vpRxyzVector wre; // reference frame to end-effector frame rotations
// Update the transformation between reference frame and end-effector frame
for (unsigned int i=0; i < 3; i++) {
  wte[i] = position[i];   // tx, ty, tz
  wre[i] = position[i+3]; // ry, ry, rz
}
// Create a rotation matrix from the Rxyz rotation angles
vpRotationMatrix wRe(wre); // reference frame to end-effector frame rotation matrix
// Create reference frame to end-effector frame transformation in terms of an homogeneous matrix
vpHomogeneousMatrix wMe(wte, wRe);

Implements vpRobot.

Examples:: servoKinovaJacoCart.cpp, and servoKinovaJacoJoint.cpp.

Definition at line 507 of file vpRobotKinova.cpp.

References vpRobot::END_EFFECTOR_FRAME, vpException::fatalError, getJointPosition(), vpRobot::JOINT_STATE, m_devices_count, m_plugin_loaded, and vpColVector::resize().

Referenced by getPosition(), and setCartVelocity().

◆ getPosition() [2/3]

void vpRobotKinova::getPosition	(	const vpRobot::vpControlFrameType	frame,
		vpPoseVector &	pose
	)

Get robot position.

Parameters

[in]	frame	: Type of cartesian position to retrieve. Admissible value is: vpRobot::END_EFFECTOR_FRAME to retrieve the cartesian position of the end-effector frame wrt the robot base frame.
[out]	pose	: Cartesian position of the end-effector in the robot base frame as a 6-dim pose vector, with first the 3 translations expressed in meter, and then the 3 rotations in radian as a $\theta {\bf u}$ vector (see vpThetaUVector).

The following code shows how to use this function and convert the resulting position into an homogeneous matrix that gives the transformation between the robot base frame and the end-effector:

vpPoseVector pose;
...
robot.getPosition(vpRobot::END_EFFECTOR_FRAME, pose);
// Create reference frame to end-effector frame transformation in terms of an homogeneous matrix
vpHomogeneousMatrix wMe(pose);

Definition at line 554 of file vpRobotKinova.cpp.

References vpException::fatalError, getPosition(), and vpRobot::JOINT_STATE.

◆ getPosition() [3/3]

vpColVector vpRobot::getPosition ( const vpRobot::vpControlFrameType frame )

inherited

Return the current robot position in the specified frame.

Definition at line 216 of file vpRobot.cpp.

References vpRobot::getPosition().

◆ getRobotFrame()

vpControlFrameType vpRobot::getRobotFrame ( void ) const

inlineprotectedinherited

Definition at line 172 of file vpRobot.h.

Referenced by vpSimulatorAfma6::computeArticularVelocity(), and vpSimulatorViper850::computeArticularVelocity().

◆ getRobotState()

virtual vpRobotStateType vpRobot::getRobotState ( void ) const

inlinevirtualinherited

Definition at line 144 of file vpRobot.h.

◆ homing()

void vpRobotKinova::homing ( )

Move the robot to home position.

Examples:: servoKinovaJacoCart.cpp, and servoKinovaJacoJoint.cpp.

Definition at line 785 of file vpRobotKinova.cpp.

References vpException::fatalError, m_devices_count, m_plugin_loaded, and m_verbose.

◆ init()

void vpRobotKinova::init ( void )

protectedvirtual

Basic initialization.

Implements vpRobot.

Definition at line 93 of file vpRobotKinova.cpp.

References m_devices_list, vpRobot::maxRotationVelocity, vpRobot::maxRotationVelocityDefault, vpRobot::maxTranslationVelocity, vpRobot::maxTranslationVelocityDefault, and vpRobot::nDof.

Referenced by vpRobotKinova().

◆ loadPlugin()

void vpRobotKinova::loadPlugin ( )

protected

Load functions from Jaco SDK plugin.

When command layer is set to CMD_LAYER_USB we load Kinova.API.USBCommandLayerUbuntu.so or CommandLayerWindows.dll respectively on unix-like or Windows platform.
When command layer is set to CMD_LAYER_ETHERNET we load Kinova.API.EthCommandLayerUbuntu.so or CommandLayerEthernet.dll respectively on unix-like or Windows platform.

There is setPluginLocation() that allows to modify the default location of the plugin set to "./".

See also: setPluginLocation(), setCommandLayer()

Definition at line 696 of file vpRobotKinova.cpp.

References closePlugin(), CMD_LAYER_UNSET, CMD_LAYER_USB, vpIoTools::createFilePath(), vpException::fatalError, m_command_layer, m_plugin_loaded, m_plugin_location, and m_verbose.

Referenced by connect().

◆ saturateVelocities()

vpColVector vpRobot::saturateVelocities	(	const vpColVector &	v_in,
		const vpColVector &	v_max,
		bool	verbose = `false`
	)

staticinherited

Saturate velocities.

Parameters

v_in	: Vector of input velocities to saturate. Translation velocities should be expressed in m/s while rotation velocities in rad/s.
v_max	: Vector of maximal allowed velocities. Maximal translation velocities should be expressed in m/s while maximal rotation velocities in rad/s.
verbose	: Print a message indicating which axis causes the saturation.

Returns: Saturated velocities.

Exceptions

vpRobotException::dimensionError : If the input vectors have different dimensions.

The code below shows how to use this static method in order to saturate a velocity skew vector.

#include <iostream>
#include <visp3/robot/vpRobot.h>
int main()
{
  // Set a velocity skew vector
  vpColVector v(6);
  v[0] = 0.1;               // vx in m/s
  v[1] = 0.2;               // vy
  v[2] = 0.3;               // vz
  v[3] = vpMath::rad(10);   // wx in rad/s
  v[4] = vpMath::rad(-10);  // wy
  v[5] = vpMath::rad(20);   // wz
  // Set the maximal allowed velocities
  vpColVector v_max(6);
  for (int i=0; i<3; i++)
    v_max[i] = 0.3;             // in translation (m/s)
  for (int i=3; i<6; i++)
    v_max[i] = vpMath::rad(10); // in rotation (rad/s)
  // Compute the saturated velocity skew vector
  vpColVector v_sat = vpRobot::saturateVelocities(v, v_max, true);
  std::cout << "v    : " << v.t() << std::endl;
  std::cout << "v max: " << v_max.t() << std::endl;
  std::cout << "v sat: " << v_sat.t() << std::endl;
  return 0;
}

Definition at line 163 of file vpRobot.cpp.

References vpException::dimensionError, and vpArray2D< Type >::size().

Referenced by vpRobotTemplate::setVelocity(), vpSimulatorCamera::setVelocity(), vpRobotCamera::setVelocity(), vpSimulatorPioneer::setVelocity(), vpRobotPioneer::setVelocity(), vpSimulatorPioneerPan::setVelocity(), vpRobotFlirPtu::setVelocity(), setVelocity(), vpRobotAfma4::setVelocity(), vpRobotAfma6::setVelocity(), vpRobotFranka::setVelocity(), vpRobotViper650::setVelocity(), and vpRobotViper850::setVelocity().

◆ set_eMc()

void vpRobotKinova::set_eMc ( vpHomogeneousMatrix & eMc )

inline

Set constant transformation between end-effector and tool frame. If your tool is a camera, this transformation is obtained by hand-eye calibration.

Definition at line 126 of file vpRobotKinova.h.

◆ setActiveDevice()

void vpRobotKinova::setActiveDevice ( int device )

Set active device.

Parameters

[in] device : Device id corresponding to the active device. The first device has id 0. The last device is is given by getNumDevices() - 1. By default, the active device is the first one.

To know how many devices are connected, use getNumDevices().

See also: getActiveDevice()

Definition at line 842 of file vpRobotKinova.cpp.

References vpException::badValue, vpException::fatalError, m_active_device, m_devices_count, m_devices_list, and m_plugin_loaded.

Referenced by connect().

◆ setCartVelocity()

void vpRobotKinova::setCartVelocity	(	const vpRobot::vpControlFrameType	frame,
		const vpColVector &	v
	)

protected

Send to the controller a 6-dim velocity twist vector expressed in a Cartesian frame.

Parameters

[in]	frame	: Cartesian control frame. Units are m/s for translation and rad/s for rotation velocities. In CAMERA_FRAME or TOOL_FRAME, we consider that v 6-dim velocity twist vector contains translation and rotation velocities expressed in the camera or tool frame respectively. In END_EFFECTOR_FRAME, we consider that v 6-dim velocity twist vector contains translation and rotation velocities expressed in the end-effector frame. In MIXT_FRAME, we consider that v 6-dim velocity twist vector contains translation velocities expressed in the base frame and rotation velocities expressed in the effector frame.
[in]	v	: 6-dim velocity twist vector that contains 3 translation velocities followed by 3 rotation velocities. Units are m/s for translation and rad/s for rotation velocities.

Definition at line 178 of file vpRobotKinova.cpp.

References vpRobot::CAMERA_FRAME, vpRobot::END_EFFECTOR_FRAME, vpMatrix::eye(), vpException::fatalError, getPosition(), vpMatrix::insert(), vpRobot::JOINT_STATE, m_eMc, vpRobot::MIXT_FRAME, vpRobot::REFERENCE_FRAME, and vpArray2D< Type >::size().

Referenced by setVelocity().

◆ setCommandLayer()

void vpRobotKinova::setCommandLayer ( CommandLayer command_layer )

inline

Set command layer indicating if the robot is controlled throw USB or Ethernet.

Parameters

[in] command_layer : Layer used to control the robot.

Examples:: servoKinovaJacoCart.cpp, and servoKinovaJacoJoint.cpp.

Definition at line 132 of file vpRobotKinova.h.

References vpRobot::setPosition().

◆ setDoF()

void vpRobotKinova::setDoF ( unsigned int dof )

Specify Jaco robot degrees of freedom.

Parameters

dof	: Possible values are 4, 6 or 7 corresponding to the degrees of freedom of your Kinova Jaco robot.

Examples:: servoKinovaJacoCart.cpp, and servoKinovaJacoJoint.cpp.

Definition at line 80 of file vpRobotKinova.cpp.

References vpException::fatalError, and vpRobot::nDof.

◆ setJointVelocity()

void vpRobotKinova::setJointVelocity ( const vpColVector & qdot )

protected

Send a joint velocity to the controller.

Parameters

[in] qdot : Joint velocities vector. Units are rad/s for a robot arm joint velocities.

Definition at line 307 of file vpRobotKinova.cpp.

References vpMath::deg(), vpException::dimensionError, vpException::fatalError, vpRobot::nDof, and vpArray2D< Type >::size().

Referenced by setVelocity().

◆ setMaxRotationVelocity()

void vpRobot::setMaxRotationVelocity ( double w_max )

inherited

Set the maximal rotation velocity that can be sent to the robot during a velocity control.

Parameters

w_max : Maximum rotational velocity expressed in rad/s.

Examples:: servoMomentPoints.cpp, servoSimu4Points.cpp, servoSimuSphere.cpp, testFeatureSegment.cpp, testFrankaJointVelocityLimits.cpp, and testRobotFlirPtu.cpp.

Definition at line 260 of file vpRobot.cpp.

References vpRobot::maxRotationVelocity.

Referenced by vpRobotViper650::getControlMode(), vpRobotViper850::getControlMode(), vpRobotViper650::setMaxRotationVelocity(), vpRobotViper850::setMaxRotationVelocity(), vpSimulatorAfma6::setPosition(), vpRobotCamera::vpRobotCamera(), and vpSimulatorCamera::vpSimulatorCamera().

◆ setMaxTranslationVelocity()

void vpRobot::setMaxTranslationVelocity ( double v_max )

inherited

Set the maximal translation velocity that can be sent to the robot during a velocity control.

Parameters

v_max : Maximum translation velocity expressed in m/s.

Examples:: servoMomentPoints.cpp, servoSimu4Points.cpp, servoSimuSphere.cpp, simulateCircle2DCamVelocity.cpp, simulateFourPoints2DCartesianCamVelocity.cpp, simulateFourPoints2DPolarCamVelocity.cpp, and testFeatureSegment.cpp.

Definition at line 239 of file vpRobot.cpp.

References vpRobot::maxTranslationVelocity.

Referenced by vpSimulatorAfma6::setPosition(), vpRobotCamera::vpRobotCamera(), and vpSimulatorCamera::vpSimulatorCamera().

◆ setPluginLocation()

void vpRobotKinova::setPluginLocation ( const std::string & plugin_location )

inline

Parameters

[in] plugin_location Path to Jaco SDK plugins (ie. Kinova.API.USBCommandLayerUbuntu.so on unix-like platform or CommandLayerWindows.dll on Windows platform). By default this location is empty, meaning that we suppose that the plugins are located in the same folder as the binary that want to use them.

Examples:: servoKinovaJacoCart.cpp, and servoKinovaJacoJoint.cpp.

Definition at line 141 of file vpRobotKinova.h.

References vpRobot::setVelocity().

◆ setPosition()

void vpRobotKinova::setPosition	(	const vpRobot::vpControlFrameType	frame,
		const vpColVector &	q
	)

virtual

Set a position to reach.

Parameters

[in]	frame	: Considered cartesian frame or joint state.
[in]	q	: Position to reach.

Implements vpRobot.

Examples:: servoKinovaJacoCart.cpp, and servoKinovaJacoJoint.cpp.

Definition at line 581 of file vpRobotKinova.cpp.

References vpMath::deg(), vpRobot::END_EFFECTOR_FRAME, vpException::fatalError, vpRobot::JOINT_STATE, m_devices_count, m_plugin_loaded, m_verbose, vpRobot::nDof, vpArray2D< Type >::size(), and vpColVector::t().

◆ setRobotFrame()

vpRobot::vpControlFrameType vpRobot::setRobotFrame ( vpRobot::vpControlFrameType newFrame )

protectedinherited

Definition at line 207 of file vpRobot.cpp.

Referenced by vpSimulatorAfma6::init(), vpSimulatorViper850::init(), vpSimulatorCamera::setVelocity(), vpSimulatorPioneer::setVelocity(), vpSimulatorPioneerPan::setVelocity(), vpSimulatorAfma6::setVelocity(), and vpSimulatorViper850::setVelocity().

◆ setRobotState()

vpRobot::vpRobotStateType vpRobot::setRobotState ( const vpRobot::vpRobotStateType newState )

virtualinherited

Reimplemented in vpRobotViper850, vpRobotViper650, vpRobotFranka, vpRobotAfma6, vpRobotAfma4, vpSimulatorViper850, vpSimulatorAfma6, vpRobotFlirPtu, vpRobotBiclops, and vpRobotPtu46.

Examples:: moveBiclops.cpp, photometricVisualServoing.cpp, photometricVisualServoingWithoutVpServo.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoKinovaJacoCart.cpp, servoKinovaJacoJoint.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, tutorial-ibvs-4pts-wireframe-robot-afma6.cpp, and tutorial-ibvs-4pts-wireframe-robot-viper.cpp.

Definition at line 201 of file vpRobot.cpp.

Referenced by vpRobotViper650::getControlMode(), vpRobotViper850::getControlMode(), vpRobotFranka::getHandler(), vpRobotFlirPtu::set_eMc(), vpSimulatorCamera::setPosition(), vpRobotCamera::setPosition(), vpSimulatorAfma6::setPositioningVelocity(), vpSimulatorViper850::setPositioningVelocity(), vpRobotPtu46::setRobotState(), vpRobotBiclops::setRobotState(), vpRobotFlirPtu::setRobotState(), vpSimulatorAfma6::setRobotState(), vpSimulatorViper850::setRobotState(), vpRobotAfma4::setRobotState(), vpRobotAfma6::setRobotState(), vpRobotFranka::setRobotState(), vpRobotViper650::setRobotState(), vpRobotViper850::setRobotState(), vpSimulatorCamera::setVelocity(), vpRobotCamera::setVelocity(), vpSimulatorPioneer::setVelocity(), vpSimulatorPioneerPan::setVelocity(), vpSimulatorAfma6::stopMotion(), and vpSimulatorViper850::stopMotion().

◆ setVelocity()

void vpRobotKinova::setVelocity	(	const vpRobot::vpControlFrameType	frame,
		const vpColVector &	vel
	)

virtual

Send to the controller a velocity in a given frame.

Parameters

[in]	frame	: Control frame in which the velocity vel is expressed. In cartesian control frames, units are m/s for translation and rad/s for rotation velocities. In CAMERA_FRAME or TOOL_FRAME, we consider that vel 6-dim velocity twist vector contains translation and rotation velocities expressed in the camera or tool frame respectively. In END_EFFECTOR_FRAME, we consider that vel 6-dim velocity twist vector contains translation and rotation velocities expressed in the end-effector frame. In MIXT_FRAME, we consider that vel 6-dim velocity twist vector contains translation velocities expressed in the base frame and rotation velocities expressed in the effector frame. To send a joint velocity, use rather JOINT_STATE. Units are rad/s for a robot arm joint velocities.
[in]	vel	: Vector that contains the velocity to apply to the robot. In cartesian control frames, 6-dim velocity twist vector that contains 3 translation velocities followed by 3 rotation velocities. When a joint velocities vector is given, 6-dim vector corresponding to joint velocities.

Implements vpRobot.

Examples:: servoKinovaJacoCart.cpp, and servoKinovaJacoJoint.cpp.

Definition at line 370 of file vpRobotKinova.cpp.

References vpException::dimensionError, vpRobot::END_EFFECTOR_FRAME, vpException::fatalError, vpRobot::getMaxRotationVelocity(), vpRobot::getMaxTranslationVelocity(), vpRobot::getRobotState(), vpRobot::JOINT_STATE, m_devices_count, m_plugin_loaded, vpRobot::MIXT_FRAME, vpRobot::nDof, vpRobot::REFERENCE_FRAME, vpRobot::saturateVelocities(), setCartVelocity(), setJointVelocity(), vpArray2D< Type >::size(), vpRobot::STATE_VELOCITY_CONTROL, vpRobot::TOOL_FRAME, and vpRobotException::wrongStateError.

◆ setVerbose()

void vpRobotKinova::setVerbose ( bool verbose )

inline

Enable or disable verbose mode to print to stdout additional information.

Parameters

[in] verbose : true to enable verbose, false to disable. By default verbose mode is disabled.

Examples:: servoKinovaJacoCart.cpp, and servoKinovaJacoJoint.cpp.

Definition at line 148 of file vpRobotKinova.h.

References vpRobot::init().

Member Data Documentation

◆ areJointLimitsAvailable

int vpRobot::areJointLimitsAvailable

protectedinherited

Definition at line 112 of file vpRobot.h.

Referenced by vpRobot::operator=(), vpRobotCamera::vpRobotCamera(), vpSimulatorCamera::vpSimulatorCamera(), vpSimulatorPioneer::vpSimulatorPioneer(), and vpSimulatorPioneerPan::vpSimulatorPioneerPan().

◆ eJe

vpMatrix vpRobot::eJe

protectedinherited

robot Jacobian expressed in the end-effector frame

Definition at line 104 of file vpRobot.h.

Referenced by vpRobotFlirPtu::get_eJe(), vpSimulatorCamera::get_eJe(), vpRobotCamera::get_eJe(), vpRobot::operator=(), vpRobotAfma4::setVelocity(), vpRobotCamera::vpRobotCamera(), and vpSimulatorCamera::vpSimulatorCamera().

◆ eJeAvailable

int vpRobot::eJeAvailable

protectedinherited

is the robot Jacobian expressed in the end-effector frame available

Definition at line 106 of file vpRobot.h.

Referenced by vpRobot::operator=(), vpRobotCamera::vpRobotCamera(), vpSimulatorCamera::vpSimulatorCamera(), vpSimulatorPioneer::vpSimulatorPioneer(), and vpSimulatorPioneerPan::vpSimulatorPioneerPan().

◆ fJe

vpMatrix vpRobot::fJe

protectedinherited

robot Jacobian expressed in the robot reference frame available

Definition at line 108 of file vpRobot.h.

Referenced by vpRobotFlirPtu::get_fJe(), and vpRobot::operator=().

◆ fJeAvailable

int vpRobot::fJeAvailable

protectedinherited

is the robot Jacobian expressed in the robot reference frame available

Definition at line 110 of file vpRobot.h.

Referenced by vpRobot::operator=(), vpRobotCamera::vpRobotCamera(), vpSimulatorCamera::vpSimulatorCamera(), vpSimulatorPioneer::vpSimulatorPioneer(), and vpSimulatorPioneerPan::vpSimulatorPioneerPan().

◆ m_active_device

int vpRobotKinova::m_active_device

protected

Definition at line 165 of file vpRobotKinova.h.

Referenced by setActiveDevice().

◆ m_command_layer

CommandLayer vpRobotKinova::m_command_layer

protected

Definition at line 166 of file vpRobotKinova.h.

Referenced by loadPlugin().

◆ m_devices_count

int vpRobotKinova::m_devices_count

protected

Definition at line 163 of file vpRobotKinova.h.

Referenced by connect(), get_eJe(), get_fJe(), getDisplacement(), getPosition(), homing(), setActiveDevice(), setPosition(), and setVelocity().

◆ m_devices_list

KinovaDevice* vpRobotKinova::m_devices_list

protected

Definition at line 164 of file vpRobotKinova.h.

Referenced by connect(), init(), setActiveDevice(), and ~vpRobotKinova().

◆ m_eMc

vpHomogeneousMatrix vpRobotKinova::m_eMc

protected

Constant transformation between end-effector and tool (or camera) frame.

Definition at line 159 of file vpRobotKinova.h.

Referenced by setCartVelocity().

◆ m_plugin_loaded

bool vpRobotKinova::m_plugin_loaded

protected

Definition at line 162 of file vpRobotKinova.h.

Referenced by closePlugin(), connect(), get_eJe(), get_fJe(), getDisplacement(), getPosition(), homing(), loadPlugin(), setActiveDevice(), setPosition(), and setVelocity().

◆ m_plugin_location

std::string vpRobotKinova::m_plugin_location

protected

Definition at line 160 of file vpRobotKinova.h.

Referenced by loadPlugin().

◆ m_verbose

bool vpRobotKinova::m_verbose

protected

Definition at line 161 of file vpRobotKinova.h.

Referenced by closePlugin(), connect(), homing(), loadPlugin(), and setPosition().

◆ maxRotationVelocity

double vpRobot::maxRotationVelocity

protectedinherited

Definition at line 98 of file vpRobot.h.

Referenced by vpRobot::getMaxRotationVelocity(), vpRobotTemplate::init(), vpRobotFlirPtu::init(), init(), vpRobot::operator=(), vpRobot::setMaxRotationVelocity(), vpRobotPtu46::setVelocity(), vpRobotViper650::vpRobotViper650(), and vpRobotViper850::vpRobotViper850().

◆ maxRotationVelocityDefault

const double vpRobot::maxRotationVelocityDefault = 0.7

staticprotectedinherited

Definition at line 99 of file vpRobot.h.

Referenced by vpRobotTemplate::init(), vpRobotFlirPtu::init(), and init().

◆ maxTranslationVelocity

double vpRobot::maxTranslationVelocity

protectedinherited

Definition at line 96 of file vpRobot.h.

Referenced by vpRobot::getMaxTranslationVelocity(), vpRobotTemplate::init(), vpRobotFlirPtu::init(), init(), vpRobot::operator=(), and vpRobot::setMaxTranslationVelocity().

◆ maxTranslationVelocityDefault

const double vpRobot::maxTranslationVelocityDefault = 0.2

staticprotectedinherited

Definition at line 97 of file vpRobot.h.

Referenced by vpRobotTemplate::init(), vpRobotFlirPtu::init(), and init().

◆ nDof

int vpRobot::nDof

protectedinherited

number of degrees of freedom

Definition at line 102 of file vpRobot.h.

Referenced by getJointPosition(), vpRobotTemplate::init(), vpRobotFlirPtu::init(), init(), vpRobot::operator=(), setDoF(), setJointVelocity(), setPosition(), vpRobotTemplate::setVelocity(), vpRobotFlirPtu::setVelocity(), setVelocity(), vpRobotCamera::vpRobotCamera(), vpRobotFranka::vpRobotFranka(), vpSimulatorCamera::vpSimulatorCamera(), vpSimulatorPioneer::vpSimulatorPioneer(), and vpSimulatorPioneerPan::vpSimulatorPioneerPan().

◆ qmax

double* vpRobot::qmax

protectedinherited

Definition at line 114 of file vpRobot.h.

Referenced by vpRobot::operator=(), vpRobotCamera::vpRobotCamera(), vpSimulatorCamera::vpSimulatorCamera(), vpSimulatorPioneer::vpSimulatorPioneer(), vpSimulatorPioneerPan::vpSimulatorPioneerPan(), and vpRobot::~vpRobot().

◆ qmin

double* vpRobot::qmin

protectedinherited

Definition at line 113 of file vpRobot.h.

Referenced by vpRobot::operator=(), vpRobotCamera::vpRobotCamera(), vpSimulatorCamera::vpSimulatorCamera(), vpSimulatorPioneer::vpSimulatorPioneer(), vpSimulatorPioneerPan::vpSimulatorPioneerPan(), and vpRobot::~vpRobot().

◆ verbose_

bool vpRobot::verbose_

protectedinherited

Definition at line 116 of file vpRobot.h.

Referenced by vpRobotAfma4::init(), vpRobotAfma6::init(), vpRobotViper650::init(), vpRobotViper850::init(), vpRobot::operator=(), vpRobotAfma4::vpRobotAfma4(), vpRobotAfma6::vpRobotAfma6(), vpRobotViper650::vpRobotViper650(), and vpRobotViper850::vpRobotViper850().

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ CommandLayer

◆ vpControlFrameType

◆ vpRobotStateType

Constructor & Destructor Documentation

◆ vpRobotKinova()

◆ ~vpRobotKinova()

Member Function Documentation

◆ closePlugin()

◆ connect()

◆ get_eJe()

◆ get_eMc()

◆ get_fJe()

◆ getActiveDevice()

◆ getDisplacement()

◆ getJointPosition()

◆ getMaxRotationVelocity()

◆ getMaxTranslationVelocity()

◆ getNumDevices()

◆ getPosition() [1/3]

◆ getPosition() [2/3]

◆ getPosition() [3/3]

◆ getRobotFrame()

◆ getRobotState()

◆ homing()

◆ init()

◆ loadPlugin()

◆ saturateVelocities()

◆ set_eMc()

◆ setActiveDevice()

◆ setCartVelocity()

◆ setCommandLayer()

◆ setDoF()

◆ setJointVelocity()

◆ setMaxRotationVelocity()

◆ setMaxTranslationVelocity()

◆ setPluginLocation()

◆ setPosition()

◆ setRobotFrame()

◆ setRobotState()

◆ setVelocity()

◆ setVerbose()

Member Data Documentation

◆ areJointLimitsAvailable

◆ eJe

◆ eJeAvailable

◆ fJe

◆ fJeAvailable

◆ m_active_device

◆ m_command_layer

◆ m_devices_count

◆ m_devices_list

◆ m_eMc

◆ m_plugin_loaded

◆ m_plugin_location

◆ m_verbose

◆ maxRotationVelocity

◆ maxRotationVelocityDefault

◆ maxTranslationVelocity

◆ maxTranslationVelocityDefault

◆ nDof

◆ qmax

◆ qmin

◆ verbose_