YARP
Yet Another Robot Platform
yarp::dev Namespace Reference

An interface for the device drivers. More...

Detailed Description

An interface for the device drivers.

Namespaces

 impl
 
 Nav2D
 
 RGBDRosConversionUtils
 
 ROSPixelCode
 

Classes

class  AudioBufferSize
 
class  audioBufferSizeData
 
struct  CalibrationParameters
 
struct  CameraConfig
 Struct describing a possible camera configuration. More...
 
class  CanBuffer
 
class  CanErrors
 
class  CanMessage
 
class  CartesianEvent
 Interface for a event notified by the cartesian controller. More...
 
struct  CartesianEventParameters
 Structure for configuring a cartesian event. More...
 
struct  CartesianEventVariables
 Structure for configuring a cartesian event. More...
 
class  CircularAudioBuffer
 
class  ControlBoardHelper
 
class  DeprecatedDeviceDriver
 
struct  DeviceDescription
 
class  DeviceDriver
 
class  DeviceResponder
 
class  DriverCreator
 A base class for factories that create driver objects. More...
 
class  DriverCreatorOf
 A factory for creating driver objects of a particular type. More...
 
class  DriverLinkCreator
 A factory for creating links to a driver that has already been created. More...
 
class  Drivers
 
class  FrameGrabberControls_Parser
 
class  FrameGrabberControls_Sender
 This classes implement a sender / parser for IFrameGrabberControls interface messages. More...
 
class  GazeEvent
 Interface for a event notified by the gaze controller. More...
 
struct  GazeEventParameters
 Structure for configuring a gaze event. More...
 
struct  GazeEventVariables
 Structure for retrieving information from a gaze event. More...
 
class  IAmplifierControl
 
class  IAmplifierControlRaw
 Interface for control devices, amplifier commands. More...
 
class  IAnalogSensor
 
class  IAudioGrabberSound
 
class  IAudioRender
 
class  IAudioVisualGrabber
 
class  IAudioVisualStream
 
class  IAxisInfo
 
class  IAxisInfoRaw
 Interface for getting information about specific axes, if available. More...
 
class  IBattery
 
class  ICalibrator
 
class  ICanBufferFactory
 
class  ICanBus
 Interface for a can bus device. More...
 
class  ICanBusErrors
 
class  ICartesianControl
 Interface for a cartesian controller. More...
 
class  IContactLoadCellArrays
 Device interface to one or multiple contact load cell arrays. More...
 
class  IControlCalibration
 
class  IControlCalibrationRaw
 Interface for control devices, calibration commands. More...
 
class  IControlDebug
 
class  IControlLimits
 
class  IControlLimitsRaw
 Interface for control devices. More...
 
class  IControlMode
 
class  IControlModeRaw
 
class  ICurrentControl
 
class  ICurrentControlRaw
 Interface for control boards implementing current control. More...
 
class  IDepthVisualParams
 
class  IEncoderArrays
 Device interface to one or multiple arrays of encoders. More...
 
class  IEncoders
 
class  IEncodersRaw
 
class  IEncodersTimed
 Control board, extend encoder interface with timestamps. More...
 
class  IEncodersTimedRaw
 Control board, extend encoder raw interface adding timestamps. More...
 
class  IFrameGrabber
 
class  IFrameGrabberControls
 
class  IFrameGrabberControlsDC1394
 
class  IFrameGrabberImage
 
class  IFrameGrabberImageRaw
 
class  IFrameGrabberRgb
 
class  IFrameTransform
 
class  IFrameTransformClientControl
 
class  IFrameWriterAudioVisual
 
class  IFrameWriterImage
 
class  IGazeControl
 Interface for a gaze controller. More...
 
class  IGenericSensor
 
class  IGPUDevice
 
class  IImpedanceControl
 
class  IImpedanceControlRaw
 
class  IInteractionMode
 
class  IInteractionModeRaw
 
class  IJoypadController
 
class  IJoypadEvent
 
class  IJoypadEventDriven
 
class  IMotor
 
class  IMotorEncoders
 
class  IMotorEncodersRaw
 
class  IMotorRaw
 
class  Implement_DepthVisualParams_Parser
 
class  Implement_DepthVisualParams_Sender
 
class  Implement_RgbVisualParams_Parser
 
class  Implement_RgbVisualParams_Sender
 
class  ImplementAmplifierControl
 
class  ImplementAxisInfo
 
class  ImplementCanBufferFactory
 Implementation of a ICanBufferFactory. More...
 
class  ImplementControlCalibration
 
class  ImplementControlLimits
 
class  ImplementControlMode
 
class  ImplementCurrentControl
 
class  ImplementEncoders
 
class  ImplementEncodersTimed
 
class  ImplementImpedanceControl
 
class  ImplementInteractionMode
 
class  ImplementMotor
 
class  ImplementMotorEncoders
 
class  ImplementPidControl
 
class  ImplementPositionControl
 Default implementation of the IPositionControl interface. More...
 
class  ImplementPositionDirect
 Default implementation of the IPositionDirect interface. More...
 
class  ImplementPWMControl
 
class  ImplementRemoteVariables
 
class  ImplementTorqueControl
 
class  ImplementVelocityControl
 
class  ImplementVirtualAnalogSensor
 
class  IMultipleWrapper
 
class  IOrientationSensors
 Device interface to one or multiple orientation sensors, such as IMUs with on board estimation algorithms. More...
 
class  IPidControl
 
class  IPidControlRaw
 Interface for a generic control board device implementing a PID controller. More...
 
class  IPositionControl
 
class  IPositionControlRaw
 
class  IPositionDirect
 
class  IPositionDirectRaw
 
class  IPositionSensors
 Device interface to one or multiple position sensors, such as UWB localization sensors. The device returns the relative position between a lab or surface-fixed frame and a frame rigidly attached to the sensor. More...
 
class  IPreciselyTimed
 
class  IPWMControl
 
class  IPWMControlRaw
 Interface for controlling an axis, by sending directly a PWM reference signal to a motor. More...
 
class  IRangefinder2D
 
class  IRemoteCalibrator
 IRemoteCalibrator interface is meant to remotize the access of the calibration device in order to allow users to remotely call the calibration procedure for a single joint or the whole device and let the calibrator do the job. More...
 
class  IRemoteVariables
 
class  IRemoteVariablesRaw
 
class  IRGBDSensor
 
class  IRgbVisualParams
 
class  IRobotDescription
 
class  ISerialDevice
 A generic interface to serial port devices. More...
 
class  IService
 
class  ISixAxisForceTorqueSensors
 Device interface to one or multiple six axis force torque sensor. More...
 
class  ISkinPatches
 Device interface to one or more groups (patches) of tactile sensors (skin). More...
 
class  ITemperatureSensors
 Device interface to one or multiple temperature sensors. More...
 
class  IThreeAxisGyroscopes
 Device interface to one or multiple three axis gyroscopes. More...
 
class  IThreeAxisLinearAccelerometers
 Device interface to one or multiple three axis linear accelerometers. More...
 
class  IThreeAxisMagnetometers
 Device interface to one or multiple three axis magnetometers. More...
 
class  ITorqueControl
 
class  ITorqueControlRaw
 
class  IVelocityControl
 
class  IVelocityControlRaw
 
class  IVirtualAnalogSensor
 
class  IVirtualAnalogSensorRaw
 
class  IVisualServoing
 Interface for visual servoing controllers. More...
 
class  IWrapper
 
class  LaserMeasurementData
 \LaserMeasurementData More...
 
class  LaserScan2D
 
class  Lidar2DDeviceBase
 The DLidarDeviceTemplate class. More...
 
class  Map2DLocationData
 
class  Map2DPathData
 
class  MobileBaseVelocity
 
class  MotorTorqueParameters
 
class  OdometryData
 
class  OdometryData6D
 
class  OVRHeadset
 Device that manages the Oculus Rift Headset. More...
 
class  Pid
 Contains the parameters for a PID. More...
 
class  PolyDriver
 
class  PolyDriverDescriptor
 
class  PolyDriverList
 
struct  Range_t
 
class  RGBDSensorParamParser
 The RGBDSensorParamParser class. More...
 
class  StubDriverCreator
 A factory for creating driver objects from DLLs / shared libraries. More...
 
class  StubImplControlLimitsRaw
 Stub implementation of IControlLimitRaw interface. More...
 
class  StubImplEncodersRaw
 Stub implementation of IEncodersRaw interface. More...
 
class  StubImplInteractionModeRaw
 Stub implementation of IInteractionMode interface. More...
 
class  StubImplPositionControlRaw
 Stub implementation of IPositionControlRaw interface. More...
 
class  StubImplPositionDirectRaw
 Stub implementation of IPositionControl2Raw interface. More...
 
class  StubImplVelocityControlRaw
 Stub implementation of IPositionControl2Raw interface. More...
 

Typedefs

typedef yarp::os::PortablePair< yarp::sig::ImageOf< yarp::sig::PixelRgb >, yarp::sig::SoundImageRgbSound
 
typedef yarp::dev::CircularAudioBuffer< unsigned char > CircularAudioBuffer_8t
 
typedef yarp::dev::CircularAudioBuffer< unsigned short int > CircularAudioBuffer_16t
 
typedef yarp::dev::CircularAudioBuffer< unsigned int > CircularAudioBuffer_32t
 
typedef IFrameGrabberControls IFrameGrabberControls2
 This interface exports a list of general methods to discover the remote camera capabilities. More...
 
typedef IControlCalibrationRaw IControlCalibration2Raw
 
typedef IControlCalibration IControlCalibration2
 
typedef IControlLimits IControlLimits2
 
typedef IControlLimitsRaw IControlLimits2Raw
 
typedef IControlModeRaw IControlMode2Raw
 
typedef IControlMode IControlMode2
 
typedef ImplementControlLimits ImplementControlLimits2
 
typedef StubImplControlLimitsRaw StubImplControlLimits2Raw
 
typedef ImplementControlMode ImplementControlMode2
 
typedef ImplementPositionControl ImplementPositionControl2
 
typedef StubImplPositionControlRaw StubImplPositionControl2Raw
 
typedef ImplementVelocityControl ImplementVelocityControl2
 
typedef StubImplVelocityControlRaw StubImplVelocityControl2Raw
 
typedef IPositionControl IPositionControl2
 
typedef IPositionControlRaw IPositionControl2Raw
 
typedef IVelocityControl IVelocityControl2
 
typedef IVelocityControlRaw IVelocityControl2Raw
 

Enumerations

enum  JointTypeEnum {
  VOCAB_JOINTTYPE_REVOLUTE = yarp::os::createVocab('a', 't', 'r', 'v'),
  VOCAB_JOINTTYPE_PRISMATIC = yarp::os::createVocab('a', 't', 'p', 'r'),
  VOCAB_JOINTTYPE_UNKNOWN = yarp::os::createVocab('u', 'n', 'k', 'n')
}
 
enum  InteractionModeEnum {
  VOCAB_IM_STIFF = yarp::os::createVocab('s','t','i','f'),
  VOCAB_IM_COMPLIANT = yarp::os::createVocab('c','o','m','p'),
  VOCAB_IM_UNKNOWN = yarp::os::createVocab('u','n','k','n')
}
 
enum  VAS_status {
  VAS_status::VAS_OK = 0,
  VAS_status::VAS_ERROR = 1,
  VAS_status::VAS_OVF = 2,
  VAS_status::VAS_TIMEOUT = 3
}
 
enum  MAS_status {
  MAS_OK =0,
  MAS_ERROR =1,
  MAS_OVF =2,
  MAS_TIMEOUT =3,
  MAS_WAITING_FOR_FIRST_READ =4,
  MAS_UNKNOWN =5
}
 Status of a given analog sensor exposed by a multiple analog sensors interface. More...
 
enum  PidControlTypeEnum {
  VOCAB_PIDTYPE_POSITION = yarp::os::createVocab('p', 'o', 's'),
  VOCAB_PIDTYPE_VELOCITY = yarp::os::createVocab('v', 'e', 'l'),
  VOCAB_PIDTYPE_TORQUE = yarp::os::createVocab('t', 'r', 'q'),
  VOCAB_PIDTYPE_CURRENT = yarp::os::createVocab('c', 'u', 'r')
}
 
enum  PidFeedbackUnitsEnum {
  PidFeedbackUnitsEnum::RAW_MACHINE_UNITS = 0,
  PidFeedbackUnitsEnum::METRIC = 1
}
 
enum  PidOutputUnitsEnum {
  PidOutputUnitsEnum::RAW_MACHINE_UNITS = 0,
  PidOutputUnitsEnum::DUTYCYCLE_PWM_PERCENT = 1,
  PidOutputUnitsEnum::POSITION_METRIC = 2,
  PidOutputUnitsEnum::VELOCITY_METRIC = 3,
  PidOutputUnitsEnum::TORQUE_METRIC = 4,
  PidOutputUnitsEnum::CURRENT_METRIC = 5
}
 

Functions

void checkGlError (const char *file, int line, const char *func)
 

Typedef Documentation

◆ CircularAudioBuffer_16t

Definition at line 118 of file CircularAudioBuffer.h.

◆ CircularAudioBuffer_32t

◆ CircularAudioBuffer_8t

◆ IControlCalibration2

◆ IControlCalibration2Raw

◆ IControlLimits2

Definition at line 17 of file IControlLimits2.h.

◆ IControlLimits2Raw

◆ IControlMode2

Definition at line 19 of file IControlMode2.h.

◆ IControlMode2Raw

Definition at line 18 of file IControlMode2.h.

◆ IFrameGrabberControls2

This interface exports a list of general methods to discover the remote camera capabilities.

It also has the get/set feature methods so can be used in conjuntion with former IFrameGrabberControls2 or as standalone.

Deprecated:
Since YARP 3.0.0

Definition at line 27 of file FrameGrabberControl2.h.

◆ ImageRgbSound

◆ ImplementControlLimits2

◆ ImplementControlMode2

◆ ImplementPositionControl2

◆ ImplementVelocityControl2

◆ IPositionControl2

◆ IPositionControl2Raw

◆ IVelocityControl2

◆ IVelocityControl2Raw

◆ StubImplControlLimits2Raw

◆ StubImplPositionControl2Raw

◆ StubImplVelocityControl2Raw

Enumeration Type Documentation

◆ InteractionModeEnum

Enumerator
VOCAB_IM_STIFF 
VOCAB_IM_COMPLIANT 
VOCAB_IM_UNKNOWN 

Definition at line 20 of file IInteractionMode.h.

◆ JointTypeEnum

Enumerator
VOCAB_JOINTTYPE_REVOLUTE 
VOCAB_JOINTTYPE_PRISMATIC 
VOCAB_JOINTTYPE_UNKNOWN 

Definition at line 28 of file IAxisInfo.h.

◆ MAS_status

Status of a given analog sensor exposed by a multiple analog sensors interface.

Enumerator
MAS_OK 

The sensor is working correctly.

MAS_ERROR 

The sensor is in generic error state.

MAS_OVF 

The sensor reached an overflow.

MAS_TIMEOUT 

The sensor is read through the network, and the latest measurement was received before an implementation-define timeout period.

MAS_WAITING_FOR_FIRST_READ 

The sensor is read through the network, and the device is waiting to receive the first measurement.

MAS_UNKNOWN 

The sensor is in an unknown state.

Definition at line 36 of file MultipleAnalogSensorsInterfaces.h.

◆ PidControlTypeEnum

Enumerator
VOCAB_PIDTYPE_POSITION 
VOCAB_PIDTYPE_VELOCITY 
VOCAB_PIDTYPE_TORQUE 
VOCAB_PIDTYPE_CURRENT 

Definition at line 20 of file PidEnums.h.

◆ PidFeedbackUnitsEnum

Enumerator
RAW_MACHINE_UNITS 
METRIC 

Definition at line 30 of file PidEnums.h.

◆ PidOutputUnitsEnum

Enumerator
RAW_MACHINE_UNITS 
DUTYCYCLE_PWM_PERCENT 
POSITION_METRIC 
VELOCITY_METRIC 
TORQUE_METRIC 
CURRENT_METRIC 

Definition at line 36 of file PidEnums.h.

◆ VAS_status

enum yarp::dev::VAS_status
strong
Enumerator
VAS_OK 
VAS_ERROR 
VAS_OVF 
VAS_TIMEOUT 

Definition at line 30 of file IVirtualAnalogSensor.h.

Function Documentation

◆ checkGlError()

void yarp::dev::checkGlError ( const char *  file,
int  line,
const char *  func 
)

Definition at line 25 of file GLDebug.cpp.