YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::xHandControlBoard Class Reference

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-device-xhand/src/devices/xHandControlBoard/xHandControlBoard.h>

+ Inheritance diagram for yarp::dev::xHandControlBoard:

Public Member Functions

 xHandControlBoard ()
 
 ~xHandControlBoard () override
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
 
bool close () override
 Close the DeviceDriver.
 
bool setPid (const yarp::dev::PidControlTypeEnum &pidtype, int j, const yarp::dev::Pid &p) override
 Set new PID value for a joint axis.
 
bool setPids (const yarp::dev::PidControlTypeEnum &pidtype, const yarp::dev::Pid *ps) override
 Set new PID value on multiple axes.
 
bool setPidReference (const yarp::dev::PidControlTypeEnum &pidtype, int j, double ref) override
 Set the controller reference for a given axis.
 
bool setPidReferences (const yarp::dev::PidControlTypeEnum &pidtype, const double *refs) override
 Set the controller reference, multiple axes.
 
bool setPidErrorLimit (const yarp::dev::PidControlTypeEnum &pidtype, int j, double limit) override
 Set the error limit for the controller on a specific joint.
 
bool setPidErrorLimits (const yarp::dev::PidControlTypeEnum &pidtype, const double *limits) override
 Get the error limit for the controller on all joints.
 
bool getPidError (const yarp::dev::PidControlTypeEnum &pidtype, int j, double *err) override
 Get the current error for a joint.
 
bool getPidErrors (const yarp::dev::PidControlTypeEnum &pidtype, double *errs) override
 Get the error of all joints.
 
bool getPidOutput (const yarp::dev::PidControlTypeEnum &pidtype, int j, double *out) override
 Get the output of the controller (e.g.
 
bool getPidOutputs (const yarp::dev::PidControlTypeEnum &pidtype, double *outs) override
 Get the output of the controllers (e.g.
 
bool setPidOffset (const yarp::dev::PidControlTypeEnum &pidtype, int j, double v) override
 Set an offset value for a given controller.
 
bool getPid (const yarp::dev::PidControlTypeEnum &pidtype, int j, yarp::dev::Pid *p) override
 Get current PID value for a specific joint.
 
bool getPids (const yarp::dev::PidControlTypeEnum &pidtype, yarp::dev::Pid *pids) override
 Get current PID value for a specific joint.
 
bool getPidReference (const yarp::dev::PidControlTypeEnum &pidtype, int j, double *ref) override
 Get the current reference of the PID controller for a specific joint.
 
bool getPidReferences (const yarp::dev::PidControlTypeEnum &pidtype, double *refs) override
 Get the current reference of all PID controllers.
 
bool getPidErrorLimit (const yarp::dev::PidControlTypeEnum &pidtype, int j, double *limit) override
 Get the error limit for the controller on a specific joint.
 
bool getPidErrorLimits (const yarp::dev::PidControlTypeEnum &pidtype, double *limits) override
 Get the error limit for all controllers.
 
bool resetPid (const yarp::dev::PidControlTypeEnum &pidtype, int j) override
 Reset the controller of a given joint, usually sets the current status of the joint as the reference value for the PID, and resets the integrator.
 
bool disablePid (const yarp::dev::PidControlTypeEnum &pidtype, int j) override
 Disable the PID computation for a joint.
 
bool enablePid (const yarp::dev::PidControlTypeEnum &pidtype, int j) override
 Enable the PID computation for a joint.
 
bool isPidEnabled (const yarp::dev::PidControlTypeEnum &pidtype, int j, bool *enabled) override
 
bool getAxes (int *ax) override
 
bool positionMove (int j, double ref) override
 Set new reference point for a single axis.
 
bool positionMove (const double *refs) override
 Set new reference point for all axes.
 
bool positionMove (const int n_joints, const int *joints, const double *refs) override
 Set new reference point for a subset of joints.
 
bool getTargetPosition (const int joint, double *ref) override
 Get the last position reference for the specified axis.
 
bool getTargetPositions (double *refs) override
 Get the last position reference for all axes.
 
bool getTargetPositions (const int n_joint, const int *joints, double *refs) override
 Get the last position reference for the specified group of axes.
 
bool relativeMove (int j, double delta) override
 Set relative position.
 
bool relativeMove (const double *deltas) override
 Set relative position, all joints.
 
bool relativeMove (const int n_joints, const int *joints, const double *deltas) override
 Set relative position for a subset of joints.
 
bool checkMotionDone (int j, bool *flag) override
 
bool checkMotionDone (bool *flag) override
 
bool checkMotionDone (const int n_joints, const int *joints, bool *flags) override
 
bool setRefSpeed (int j, double sp) override
 
bool setRefSpeeds (const double *spds) override
 
bool setRefSpeeds (const int n_joints, const int *joints, const double *spds) override
 
bool setRefAcceleration (int j, double acc) override
 
bool setRefAccelerations (const double *accs) override
 
bool setRefAccelerations (const int n_joints, const int *joints, const double *accs) override
 
bool getRefSpeed (int j, double *ref) override
 
bool getRefSpeeds (double *spds) override
 
bool getRefSpeeds (const int n_joints, const int *joints, double *spds) override
 
bool getRefAcceleration (int j, double *acc) override
 
bool getRefAccelerations (double *accs) override
 
bool getRefAccelerations (const int n_joints, const int *joints, double *accs) override
 
bool stop (int j) override
 Stop motion, single joint.
 
bool stop () override
 Stop motion, multiple joints.
 
bool stop (const int n_joints, const int *joints) override
 Stop motion for subset of joints.
 
bool getLastJointFault (int j, int &fault, std::string &message) override
 
bool velocityMove (int j, double v) override
 Start motion at a given speed, single joint.
 
bool velocityMove (const double *v) override
 Start motion at a given speed, multiple joints.
 
bool resetEncoder (int j) override
 Reset encoder, single joint.
 
bool resetEncoders () override
 Reset encoders.
 
bool setEncoder (int j, double val) override
 Set the value of the encoder for a given joint.
 
bool setEncoders (const double *vals) override
 Set the value of all encoders.
 
bool getEncoder (int j, double *v) override
 Read the value of an encoder.
 
bool getEncoders (double *encs) override
 Read the position of all axes.
 
bool getEncodersTimed (double *encs, double *t) override
 Read the instantaneous acceleration of all axes.
 
bool getEncoderTimed (int j, double *v, double *t) override
 Read the instantaneous acceleration of all axes.
 
bool getEncoderSpeed (int j, double *sp) override
 Read the istantaneous speed of an axis.
 
bool getEncoderSpeeds (double *spds) override
 Read the instantaneous speed of all axes.
 
bool getEncoderAcceleration (int j, double *acc) override
 Read the instantaneous acceleration of an axis.
 
bool getEncoderAccelerations (double *accs) override
 Read the instantaneous acceleration of all axes.
 
bool getNumberOfMotorEncoders (int *num) override
 Get the number of available motor encoders.
 
bool resetMotorEncoder (int m) override
 Reset motor encoder, single motor.
 
bool resetMotorEncoders () override
 Reset motor encoders.
 
bool setMotorEncoderCountsPerRevolution (int m, const double cpr) override
 Sets number of counts per revolution for motor encoder m.
 
bool getMotorEncoderCountsPerRevolution (int m, double *cpr) override
 Gets number of counts per revolution for motor encoder m.
 
bool setMotorEncoder (int m, const double val) override
 Set the value of the motor encoder for a given motor.
 
bool setMotorEncoders (const double *vals) override
 Set the value of all motor encoders.
 
bool getMotorEncoder (int m, double *v) override
 Read the value of a motor encoder.
 
bool getMotorEncoders (double *encs) override
 Read the position of all motor encoders.
 
bool getMotorEncodersTimed (double *encs, double *t) override
 Read the instantaneous position of all motor encoders.
 
bool getMotorEncoderTimed (int m, double *v, double *t) override
 Read the instantaneous position of a motor encoder.
 
bool getMotorEncoderSpeed (int m, double *sp) override
 Read the instantaneous speed of a motor encoder.
 
bool getMotorEncoderSpeeds (double *spds) override
 Read the instantaneous speed of all motor encoders.
 
bool getMotorEncoderAcceleration (int m, double *acc) override
 Read the instantaneous acceleration of a motor encoder.
 
bool getMotorEncoderAccelerations (double *accs) override
 Read the instantaneous acceleration of all motor encoders.
 
bool enableAmp (int j) override
 Enable the amplifier on a specific joint.
 
bool disableAmp (int j) override
 Disable the amplifier on a specific joint.
 
bool getAmpStatus (int *st) override
 
bool getAmpStatus (int j, int *v) override
 
bool setMaxCurrent (int j, double v) override
 
bool getMaxCurrent (int j, double *v) override
 Returns the maximum electric current allowed for a given motor.
 
bool getNominalCurrent (int m, double *val) override
 
bool setNominalCurrent (int m, const double val) override
 
bool getPeakCurrent (int m, double *val) override
 
bool setPeakCurrent (int m, const double val) override
 
bool getPWM (int m, double *val) override
 
bool getPWMLimit (int m, double *val) override
 
bool setPWMLimit (int m, const double val) override
 
bool getPowerSupplyVoltage (int m, double *val) override
 
bool setLimits (int j, double min, double max) override
 
bool getLimits (int j, double *min, double *max) override
 
bool setVelLimits (int j, double min, double max) override
 Set the software speed limits for a particular axis, the behavior of the control card when these limits are exceeded, depends on the implementation.
 
bool getVelLimits (int j, double *min, double *max) override
 Get the software speed limits for a particular axis.
 
bool getRemoteVariable (std::string key, yarp::os::Bottle &val) override
 
bool setRemoteVariable (std::string key, const yarp::os::Bottle &val) override
 
bool getRemoteVariablesList (yarp::os::Bottle *listOfKeys) override
 
bool isCalibratorDevicePresent (bool *isCalib) override
 isCalibratorDevicePresent: check if a calibrator device has been set
 
yarp::dev::IRemoteCalibrator * getCalibratorDevice () override
 getCalibratorDevice: return the pointer stored with the setCalibratorDevice
 
bool calibrateSingleJoint (int j) override
 calibrateSingleJoint: call the calibration procedure for the single joint
 
bool calibrateWholePart () override
 calibrateWholePart: call the procedure for calibrating the whole device
 
bool homingSingleJoint (int j) override
 homingSingleJoint: call the homing procedure for a single joint
 
bool homingWholePart () override
 homingWholePart: call the homing procedure for a the whole part/device
 
bool parkSingleJoint (int j, bool _wait=true) override
 parkSingleJoint(): start the parking procedure for the single joint
 
bool parkWholePart () override
 parkWholePart: start the parking procedure for the whole part
 
bool quitCalibrate () override
 quitCalibrate: interrupt the calibration procedure
 
bool quitPark () override
 quitPark: interrupt the park procedure
 
bool calibrateAxisWithParams (int j, unsigned int ui, double v1, double v2, double v3) override
 Start calibration, this method is very often platform specific.
 
bool setCalibrationParameters (int j, const yarp::dev::CalibrationParameters &params) override
 Start calibration, this method is very often platform specific.
 
bool calibrationDone (int j) override
 Check if the calibration is terminated, on a particular joint.
 
bool abortPark () override
 
bool abortCalibration () override
 
bool getNumberOfMotors (int *num) override
 Retrieves the number of controlled motors from the current physical interface.
 
bool getTemperature (int m, double *val) override
 Get temperature of a motor.
 
bool getTemperatures (double *vals) override
 Get temperature of all the motors.
 
bool getTemperatureLimit (int m, double *val) override
 Retrieves the current temperature limit for a specific motor.
 
bool setTemperatureLimit (int m, const double val) override
 Set the temperature limit for a specific motor.
 
bool getGearboxRatio (int m, double *val) override
 Get the gearbox ratio for a specific motor.
 
bool setGearboxRatio (int m, const double val) override
 Set the gearbox ratio for a specific motor.
 
bool getAxisName (int j, std::string &name) override
 
bool getJointType (int j, yarp::dev::JointTypeEnum &type) override
 
bool getRefTorques (double *refs) override
 Get the reference value of the torque for all joints.
 
bool getRefTorque (int j, double *t) override
 Get the reference value of the torque for a given joint.
 
bool setRefTorques (const double *t) override
 Set the reference value of the torque for all joints.
 
bool setRefTorque (int j, double t) override
 Set the reference value of the torque for a given joint.
 
bool setRefTorques (const int n_joint, const int *joints, const double *t) override
 Set new torque reference for a subset of joints.
 
bool getMotorTorqueParams (int j, yarp::dev::MotorTorqueParameters *params) override
 Get a subset of motor parameters (bemf, ktau etc) useful for torque control.
 
bool setMotorTorqueParams (int j, const yarp::dev::MotorTorqueParameters params) override
 Set a subset of motor parameters (bemf, ktau etc) useful for torque control.
 
bool setImpedance (int j, double stiff, double damp) override
 Set current impedance gains (stiffness,damping) for a specific joint.
 
bool setImpedanceOffset (int j, double offset) override
 Set current force Offset for a specific joint.
 
bool getTorque (int j, double *t) override
 Get the value of the torque on a given joint (this is the feedback if you have a torque sensor).
 
bool getTorques (double *t) override
 Get the value of the torque for all joints (this is the feedback if you have torque sensors).
 
bool getTorqueRange (int j, double *min, double *max) override
 Get the full scale of the torque sensor of a given joint.
 
bool getTorqueRanges (double *min, double *max) override
 Get the full scale of the torque sensors of all joints.
 
bool getImpedance (int j, double *stiff, double *damp) override
 Get current impedance gains (stiffness,damping,offset) for a specific joint.
 
bool getImpedanceOffset (int j, double *offset) override
 Get current force Offset for a specific joint.
 
bool getCurrentImpedanceLimit (int j, double *min_stiff, double *max_stiff, double *min_damp, double *max_damp) override
 Get the current impedance limits for a specific joint.
 
bool getControlMode (int j, int *mode) override
 
bool getControlModes (int *modes) override
 
bool getControlModes (const int n_joint, const int *joints, int *modes) override
 
bool setControlMode (const int j, const int mode) override
 
bool setControlModes (const int n_joints, const int *joints, int *modes) override
 
bool setControlModes (int *modes) override
 
bool setPosition (int j, double ref) override
 Set new position for a single axis.
 
bool setPositions (const int n_joints, const int *joints, const double *dpos) override
 Set new reference point for all axes.
 
bool setPositions (const double *refs) override
 Set new position for a set of axis.
 
bool getRefPosition (const int joint, double *ref) override
 Get the last position reference for the specified axis.
 
bool getRefPositions (double *refs) override
 Get the last position reference for all axes.
 
bool getRefPositions (const int n_joint, const int *joints, double *refs) override
 Get the last position reference for the specified group of axes.
 
yarp::os::Stamp getLastInputStamp () override
 Return the time stamp relative to the last acquisition.
 
bool velocityMove (const int n_joints, const int *joints, const double *spds) override
 Start motion at a given speed for a subset of joints.
 
bool getRefVelocity (const int joint, double *vel) override
 
bool getRefVelocities (double *vels) override
 
bool getRefVelocities (const int n_joint, const int *joints, double *vels) override
 
bool getInteractionMode (int j, yarp::dev::InteractionModeEnum *mode) override
 
bool getInteractionModes (int n_joints, int *joints, yarp::dev::InteractionModeEnum *modes) override
 
bool getInteractionModes (yarp::dev::InteractionModeEnum *modes) override
 
bool setInteractionMode (int j, yarp::dev::InteractionModeEnum mode) override
 Set the interaction mode of the robot, values can be stiff or compliant.
 
bool setInteractionModes (int n_joints, int *joints, yarp::dev::InteractionModeEnum *modes) override
 
bool setInteractionModes (yarp::dev::InteractionModeEnum *modes) override
 
bool setRefDutyCycle (int m, double ref) override
 Sets the reference dutycycle to a single motor.
 
bool setRefDutyCycles (const double *refs) override
 Sets the reference dutycycle for all the motors.
 
bool getRefDutyCycle (int m, double *ref) override
 Gets the last reference sent using the setRefDutyCycle function.
 
bool getRefDutyCycles (double *refs) override
 Gets the last reference sent using the setRefDutyCycles function.
 
bool getDutyCycle (int m, double *val) override
 Gets the current dutycycle of the output of the amplifier (i.e.
 
bool getDutyCycles (double *vals) override
 Gets the current dutycycle of the output of the amplifier (i.e.
 
bool getCurrent (int m, double *curr) override
 Get the instantaneous current measurement for a single motor.
 
bool getCurrents (double *currs) override
 Get the instantaneous current measurement for all motors.
 
bool getCurrentRange (int m, double *min, double *max) override
 Get the full scale of the current measurement for a given motor (e.g.
 
bool getCurrentRanges (double *min, double *max) override
 Get the full scale of the current measurements for all motors motor (e.g.
 
bool setRefCurrents (const double *currs) override
 Set the reference value of the currents for all motors.
 
bool setRefCurrent (int m, double curr) override
 Set the reference value of the current for a single motor.
 
bool setRefCurrents (const int n_motor, const int *motors, const double *currs) override
 Set the reference value of the current for a group of motors.
 
bool getRefCurrents (double *currs) override
 Get the reference value of the currents for all motors.
 
bool getRefCurrent (int m, double *curr) override
 Get the reference value of the current for a single motor.
 
void run () override
 Loop function.
 
bool threadInit () override
 Initialization method.
 
void threadRelease () override
 Release method.
 
- Public Member Functions inherited from xHandControlBoard_ParamsParser
 xHandControlBoard_ParamsParser ()
 
 ~xHandControlBoard_ParamsParser () override=default
 
bool parseParams (const yarp::os::Searchable &config) override
 Parse the DeviceDriver parameters.
 
std::string getDeviceClassName () const override
 Get the name of the DeviceDriver class.
 
std::string getDeviceName () const override
 Get the name of the device (i.e.
 
std::string getDocumentationOfDeviceParams () const override
 Get the documentation of the DeviceDriver's parameters.
 
std::vector< std::string > getListOfParams () const override
 Return a list of all params used by the device.
 
bool getParamValue (const std::string &paramName, std::string &paramValue) const override
 Return the value (represented as a string) of the requested parameter.
 
std::string getConfiguration () const override
 Return the configuration of the device.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 
 DeviceDriver (const DeviceDriver &other)=delete
 
 DeviceDriver (DeviceDriver &&other) noexcept=delete
 
DeviceDriver & operator= (const DeviceDriver &other)=delete
 
DeviceDriver & operator= (DeviceDriver &&other) noexcept=delete
 
virtual ~DeviceDriver ()
 
virtual std::string id () const
 Return the id assigned to the PolyDriver.
 
virtual void setId (const std::string &id)
 Set the id for this device.
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver.
 
virtual DeviceDriver * getImplementation ()
 Some drivers are bureaucrats, pointing at others.
 
- Public Member Functions inherited from yarp::dev::IPidControl
virtual ~IPidControl ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAvailablePids (int j, std::vector< PidControlTypeEnum > &avail)=0
 Return a list of available pid types mode for the given joint.
 
virtual yarp::dev::ReturnValue getPidExtraInfo (const PidControlTypeEnum &pidtype, int j, yarp::dev::PidExtraInfo &info)=0
 Get PID extra info and measurement units for a specific joint.
 
virtual yarp::dev::ReturnValue getPidExtraInfos (const PidControlTypeEnum &pidtype, std::vector< yarp::dev::PidExtraInfo > &info)=0
 Get PID extra info and measurement units for a specific joint.
 
virtual yarp::dev::ReturnValue setPidFeedforward (const PidControlTypeEnum &pidtype, int j, double v)=0
 Set the feedforward value for the specified PID controller.
 
virtual yarp::dev::ReturnValue getPidOffset (const PidControlTypeEnum &pidtype, int j, double &v)=0
 Get the currently set offset value for the specified PID controller.
 
virtual yarp::dev::ReturnValue getPidFeedforward (const PidControlTypeEnum &pidtype, int j, double &v)=0
 Get the currently set feedforward value for the specified PID controller.
 
virtual yarp::dev::ReturnValue isPidEnabled (const PidControlTypeEnum &pidtype, int j, bool &enabled)=0
 Get the current status (enabled/disabled) of the PID.
 
- Public Member Functions inherited from yarp::dev::IPositionControl
virtual ~IPositionControl ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &ax)=0
 Get the number of controlled axes.
 
virtual yarp::dev::ReturnValue checkMotionDone (int j, bool &flag)=0
 Check if the current trajectory is terminated.
 
virtual yarp::dev::ReturnValue checkMotionDone (bool &flag)=0
 Check if the current trajectory is terminated.
 
virtual yarp::dev::ReturnValue setTrajSpeed (int j, double sp)=0
 Set reference speed for a joint, this is the speed used during the interpolation of the trajectory.
 
virtual yarp::dev::ReturnValue setTrajSpeeds (const double *spds)=0
 Set reference speed on all joints.
 
virtual yarp::dev::ReturnValue setTrajAcceleration (int j, double acc)=0
 Set reference acceleration for a joint.
 
virtual yarp::dev::ReturnValue setTrajAccelerations (const double *accs)=0
 Set reference acceleration on all joints.
 
virtual yarp::dev::ReturnValue getTrajSpeed (int j, double *ref)=0
 Get reference speed for a joint.
 
virtual yarp::dev::ReturnValue getTrajSpeeds (double *spds)=0
 Get reference speed of all joints.
 
virtual yarp::dev::ReturnValue getTrajAcceleration (int j, double *acc)=0
 Get reference acceleration for a joint.
 
virtual yarp::dev::ReturnValue getTrajAccelerations (double *accs)=0
 Get reference acceleration of all joints.
 
virtual yarp::dev::ReturnValue checkMotionDone (const std::vector< int > &joints, bool &flag)=0
 Check if the current trajectory is terminated.
 
virtual yarp::dev::ReturnValue setTrajSpeeds (const int n_joint, const int *joints, const double *spds)=0
 Set reference speed on all joints.
 
virtual yarp::dev::ReturnValue setTrajAccelerations (const int n_joint, const int *joints, const double *accs)=0
 Set reference acceleration on all joints.
 
virtual yarp::dev::ReturnValue getTrajSpeeds (const int n_joint, const int *joints, double *spds)=0
 Get reference speed of all joints.
 
virtual yarp::dev::ReturnValue getTrajAccelerations (const int n_joint, const int *joints, double *accs)=0
 Get reference acceleration for a joint.
 
- Public Member Functions inherited from yarp::dev::IPositionDirect
virtual ~IPositionDirect ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &ax)=0
 Get the number of controlled axes.
 
- Public Member Functions inherited from yarp::dev::IVelocityControl
virtual ~IVelocityControl ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &axes)=0
 Get the number of controlled axes.
 
virtual yarp::dev::ReturnValue setTrajAcceleration (int j, double acc)=0
 Set reference acceleration for a joint.
 
virtual yarp::dev::ReturnValue setTrajAccelerations (const double *accs)=0
 Set reference acceleration on all joints.
 
virtual yarp::dev::ReturnValue getTrajAcceleration (int j, double *acc)=0
 Get reference acceleration for a joint.
 
virtual yarp::dev::ReturnValue getTrajAccelerations (double *accs)=0
 Get reference acceleration of all joints.
 
virtual yarp::dev::ReturnValue getTargetVelocity (const int joint, double *vel)=0
 Get the last reference speed set by velocityMove for single joint.
 
virtual yarp::dev::ReturnValue getTargetVelocities (double *vels)=0
 Get the last reference speed set by velocityMove for all joints.
 
virtual yarp::dev::ReturnValue getTargetVelocities (const int n_joint, const int *joints, double *vels)=0
 Get the last reference speed set by velocityMove for a group of joints.
 
virtual yarp::dev::ReturnValue setTrajAccelerations (const int n_joint, const int *joints, const double *accs)=0
 Set reference acceleration for a subset of joints.
 
virtual yarp::dev::ReturnValue getTrajAccelerations (const int n_joint, const int *joints, double *accs)=0
 Get reference acceleration for a subset of joints.
 
- Public Member Functions inherited from yarp::dev::IPWMControl
virtual ~IPWMControl ()
 
- Public Member Functions inherited from yarp::dev::ICurrentControl
virtual ~ICurrentControl ()
 Destructor.
 
- Public Member Functions inherited from yarp::dev::IEncodersTimed
virtual ~IEncodersTimed ()
 Destructor.
 
- Public Member Functions inherited from yarp::dev::IEncoders
virtual ~IEncoders ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &ax)=0
 Get the number of controlled axes.
 
- Public Member Functions inherited from yarp::dev::IMotor
virtual ~IMotor ()
 Destructor.
 
- Public Member Functions inherited from yarp::dev::IMotorEncoders
virtual ~IMotorEncoders ()
 Destructor.
 
- Public Member Functions inherited from yarp::dev::IAmplifierControl
virtual ~IAmplifierControl ()
 Destructor.
 
- Public Member Functions inherited from yarp::dev::IControlLimits
virtual ~IControlLimits ()
 Destructor.
 
virtual yarp::dev::ReturnValue setPosLimits (int axis, double min, double max)=0
 Set the software limits for a particular axis, the behavior of the control card when these limits are exceeded, depends on the implementation.
 
virtual yarp::dev::ReturnValue getPosLimits (int axis, double *min, double *max)=0
 Get the software limits for a particular axis.
 
- Public Member Functions inherited from yarp::dev::IRemoteCalibrator
 IRemoteCalibrator ()
 This 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.
 
virtual ~IRemoteCalibrator ()=default
 
virtual yarp::dev::ReturnValue setCalibratorDevice (yarp::dev::IRemoteCalibrator *dev)
 setCalibratorDevice: store the pointer to the calibrator device.
 
virtual yarp::dev::ReturnValue releaseCalibratorDevice ()
 releaseCalibratorDevice: reset the internal pointer to NULL when stop using the calibrator
 
- Public Member Functions inherited from yarp::dev::IControlCalibration
 IControlCalibration ()
 
virtual ~IControlCalibration ()
 Destructor.
 
virtual yarp::dev::ReturnValue setCalibrator (ICalibrator *c)
 Set the calibrator object to be used to calibrate the robot.
 
virtual yarp::dev::ReturnValue calibrateRobot ()
 Calibrate robot by using an external calibrator.
 
virtual yarp::dev::ReturnValue park (bool wait=true)
 
- Public Member Functions inherited from yarp::dev::ITorqueControl
virtual ~ITorqueControl ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &ax)=0
 Get the number of controlled axes.
 
- Public Member Functions inherited from yarp::dev::IImpedanceControl
virtual ~IImpedanceControl ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &ax)=0
 Get the number of controlled axes.
 
- Public Member Functions inherited from yarp::dev::IControlMode
virtual ~IControlMode ()
 
virtual yarp::dev::ReturnValue getAvailableControlModes (int j, std::vector< yarp::dev::SelectableControlModeEnum > &avail)=0
 Return a list of available control mode for the given joint.
 
virtual yarp::dev::ReturnValue getControlMode (int j, yarp::dev::ControlModeEnum &mode)=0
 Get the current control mode.
 
virtual yarp::dev::ReturnValue getControlModes (std::vector< yarp::dev::ControlModeEnum > &mode)=0
 Get the current control mode (multiple joints).
 
virtual yarp::dev::ReturnValue getControlModes (const std::vector< int > &joints, std::vector< yarp::dev::ControlModeEnum > &mode)=0
 Get the current control mode for a subset of axes.
 
virtual yarp::dev::ReturnValue setControlMode (int j, yarp::dev::SelectableControlModeEnum mode)=0
 Set the current control mode.
 
virtual yarp::dev::ReturnValue setControlModes (const std::vector< int > &joints, const std::vector< yarp::dev::SelectableControlModeEnum > &mode)=0
 Set the current control mode for a subset of axes.
 
virtual yarp::dev::ReturnValue setControlModes (const std::vector< yarp::dev::SelectableControlModeEnum > &mode)=0
 Set the current control mode (multiple joints).
 
- Public Member Functions inherited from yarp::dev::IAxisInfo
virtual ~IAxisInfo ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &ax)=0
 Get the number of controlled axes.
 
- Public Member Functions inherited from yarp::dev::IPreciselyTimed
virtual ~IPreciselyTimed ()
 
- Public Member Functions inherited from yarp::dev::IInteractionMode
virtual ~IInteractionMode ()
 Destructor.
 
virtual yarp::dev::ReturnValue getInteractionMode (int axis, yarp::dev::InteractionModeEnum &mode)=0
 Get the current interaction mode of the robot, values can be stiff or compliant.
 
virtual yarp::dev::ReturnValue getInteractionModes (const std::vector< int > &joints, std::vector< yarp::dev::InteractionModeEnum > &modes)=0
 Get the current interaction mode of the robot for a set of joints, values can be stiff or compliant.
 
virtual yarp::dev::ReturnValue getInteractionModes (std::vector< yarp::dev::InteractionModeEnum > &modes)=0
 Get the current interaction mode of the robot for a all the joints, values can be stiff or compliant.
 
virtual yarp::dev::ReturnValue setInteractionModes (const std::vector< int > &joints, const std::vector< yarp::dev::InteractionModeEnum > &modes)=0
 Set the interaction mode of the robot for a set of joints, values can be stiff or compliant.
 
virtual yarp::dev::ReturnValue setInteractionModes (const std::vector< yarp::dev::InteractionModeEnum > &modes)=0
 Set the interaction mode of the robot for a all the joints, values can be stiff or compliant.
 
- Public Member Functions inherited from yarp::dev::IRemoteVariables
virtual ~IRemoteVariables ()
 Destructor.
 
- Public Member Functions inherited from yarp::dev::IJointFault
virtual ~IJointFault ()
 
- Public Member Functions inherited from yarp::os::PeriodicThread
 PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative)
 Constructor.
 
 PeriodicThread (double period, PeriodicThreadClock clockAccuracy)
 Constructor.
 
virtual ~PeriodicThread ()
 
bool start ()
 Call this to start the thread.
 
void step ()
 Call this to "step" the thread rather than starting it.
 
void stop ()
 Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called).
 
void askToStop ()
 Stop the thread.
 
bool isRunning () const
 Returns true when the thread is started, false otherwise.
 
bool isSuspended () const
 Returns true when the thread is suspended, false otherwise.
 
bool setPeriod (double period)
 Set the (new) period of the thread.
 
double getPeriod () const
 Return the current period of the thread.
 
void suspend ()
 Suspend the thread, the thread keeps running by doLoop is never executed.
 
void resume ()
 Resume the thread if previously suspended.
 
void resetStat ()
 Reset thread statistics.
 
double getEstimatedPeriod () const
 Return estimated period since last reset.
 
void getEstimatedPeriod (double &av, double &std) const
 Return estimated period since last reset.
 
unsigned int getIterations () const
 Return the number of iterations performed since last reset.
 
double getEstimatedUsed () const
 Return the estimated duration of the run() function since last reset.
 
void getEstimatedUsed (double &av, double &std) const
 Return estimated duration of the run() function since last reset.
 
int setPriority (int priority, int policy=-1)
 Set the priority and scheduling policy of the thread, if the OS supports that.
 
int getPriority () const
 Query the current priority of the thread, if the OS supports that.
 
int getPolicy () const
 Query the current scheduling policy of the thread, if the OS supports that.
 

Additional Inherited Members

- Public Attributes inherited from xHandControlBoard_ParamsParser
const std::string m_device_classname = {"xHandControlBoard"}
 
const std::string m_device_name = {"xHandControlBoard"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
const std::string m_connection_type_defaultValue = {"EtherCAT"}
 
const std::string m_RS485_port_defaultValue = {"/dev/ttyUSB0"}
 
const std::string m_RS485_baudrate_defaultValue = {"3000000"}
 
const std::string m_ETHERCAT_eth_ifname_defaultValue = {""}
 
const std::string m_PID_kp_defaultValue = {"225"}
 
const std::string m_PID_ki_defaultValue = {"0"}
 
const std::string m_PID_kd_defaultValue = {"12000"}
 
const std::string m_TORQUE_tor_max_defaultValue = {"350"}
 
const std::string m_MODE_mode_defaultValue = {"3"}
 
const std::string m_LIMITS_jntPosMin_defaultValue = {"(0.0 -60.0 -0.0 -5.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0)"}
 
const std::string m_LIMITS_jntPosMax_defaultValue = {"(90.0 90.0 90.0 17.0 110.0 110.0 110.0 110.0 110.0 110.0 110.0 110.0)"}
 
const std::string m_LIMITS_jntVelMin_defaultValue = {"(0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0)"}
 
const std::string m_LIMITS_jntVelMax_defaultValue = {"(100.0 100.0 100.0 100.0 100.0 100.0 100.0 100.0 100.0 100.0 100.0 100.0)"}
 
const std::string m_GENERAL_AxisName_defaultValue = {"(a a a a a a a a a a a a)"}
 
const std::string m_GENERAL_AxisType_defaultValue = {"(a a a a a a a a a a a a)"}
 
const std::string m_GENERAL_AxisMap_defaultValue = {"(0 0 0 0 0 0 0 0 0 0 0 0)"}
 
std::string m_connection_type = {"EtherCAT"}
 
std::string m_RS485_port = {"/dev/ttyUSB0"}
 
int m_RS485_baudrate = {3000000}
 
std::string m_ETHERCAT_eth_ifname = {}
 
int m_PID_kp = {225}
 
int m_PID_ki = {0}
 
int m_PID_kd = {12000}
 
int m_TORQUE_tor_max = {350}
 
int m_MODE_mode = {3}
 
std::vector< double > m_LIMITS_jntPosMin = { }
 
std::vector< double > m_LIMITS_jntPosMax = { }
 
std::vector< double > m_LIMITS_jntVelMin = { }
 
std::vector< double > m_LIMITS_jntVelMax = { }
 
std::vector< std::string > m_GENERAL_AxisName = { }
 
std::vector< std::string > m_GENERAL_AxisType = { }
 
std::vector< int > m_GENERAL_AxisMap = { }
 
- Protected Member Functions inherited from yarp::os::PeriodicThread
virtual void beforeStart ()
 Called just before a new thread starts.
 
virtual void afterStart (bool success)
 Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start().
 

Detailed Description

Definition at line 30 of file xHandControlBoard.h.

Constructor & Destructor Documentation

◆ xHandControlBoard()

yarp::dev::xHandControlBoard::xHandControlBoard ( )

Definition at line 13 of file xHandControlBoard.cpp.

◆ ~xHandControlBoard()

yarp::dev::xHandControlBoard::~xHandControlBoard ( )
override

Definition at line 18 of file xHandControlBoard.cpp.

Member Function Documentation

◆ abortCalibration()

bool yarp::dev::xHandControlBoard::abortCalibration ( )
overridevirtual

Reimplemented from yarp::dev::IControlCalibration.

Definition at line 886 of file xHandControlBoard.cpp.

◆ abortPark()

bool yarp::dev::xHandControlBoard::abortPark ( )
overridevirtual

Reimplemented from yarp::dev::IControlCalibration.

Definition at line 881 of file xHandControlBoard.cpp.

◆ calibrateAxisWithParams()

bool yarp::dev::xHandControlBoard::calibrateAxisWithParams ( int  axis,
unsigned int  type,
double  p1,
double  p2,
double  p3 
)
overridevirtual

Start calibration, this method is very often platform specific.

Returns
true/false on success failure

Implements yarp::dev::IControlCalibration.

Definition at line 866 of file xHandControlBoard.cpp.

◆ calibrateSingleJoint()

bool yarp::dev::xHandControlBoard::calibrateSingleJoint ( int  j)
overridevirtual

calibrateSingleJoint: call the calibration procedure for the single joint

Parameters
jjoint to be calibrated
Returns
true if calibration was successful

Implements yarp::dev::IRemoteCalibrator.

Definition at line 826 of file xHandControlBoard.cpp.

◆ calibrateWholePart()

bool yarp::dev::xHandControlBoard::calibrateWholePart ( )
overridevirtual

calibrateWholePart: call the procedure for calibrating the whole device

Returns
true if calibration was successful

Implements yarp::dev::IRemoteCalibrator.

Definition at line 831 of file xHandControlBoard.cpp.

◆ calibrationDone()

bool yarp::dev::xHandControlBoard::calibrationDone ( int  j)
overridevirtual

Check if the calibration is terminated, on a particular joint.

Non blocking.

Returns
true/false

Implements yarp::dev::IControlCalibration.

Definition at line 876 of file xHandControlBoard.cpp.

◆ checkMotionDone() [1/3]

bool yarp::dev::xHandControlBoard::checkMotionDone ( bool *  flag)
override

Definition at line 455 of file xHandControlBoard.cpp.

◆ checkMotionDone() [2/3]

bool yarp::dev::xHandControlBoard::checkMotionDone ( const int  n_joints,
const int *  joints,
bool *  flags 
)
override

Definition at line 461 of file xHandControlBoard.cpp.

◆ checkMotionDone() [3/3]

bool yarp::dev::xHandControlBoard::checkMotionDone ( int  j,
bool *  flag 
)
override

Definition at line 449 of file xHandControlBoard.cpp.

◆ close()

bool yarp::dev::xHandControlBoard::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 183 of file xHandControlBoard.cpp.

◆ disableAmp()

bool yarp::dev::xHandControlBoard::disableAmp ( int  j)
overridevirtual

Disable the amplifier on a specific joint.

All computations within the board will be carried out normally, but the output will be disabled.

Returns
true/false on success/failure

Implements yarp::dev::IAmplifierControl.

Definition at line 708 of file xHandControlBoard.cpp.

◆ disablePid()

bool yarp::dev::xHandControlBoard::disablePid ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j 
)
overridevirtual

Disable the PID computation for a joint.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
Returns
true on success, false on failure.

Implements yarp::dev::IPidControl.

Definition at line 377 of file xHandControlBoard.cpp.

◆ enableAmp()

bool yarp::dev::xHandControlBoard::enableAmp ( int  j)
overridevirtual

Enable the amplifier on a specific joint.

Be careful, check that the output of the controller is appropriate (usually zero), to avoid generating abrupt movements.

Returns
true/false on success/failure

Implements yarp::dev::IAmplifierControl.

Definition at line 703 of file xHandControlBoard.cpp.

◆ enablePid()

bool yarp::dev::xHandControlBoard::enablePid ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j 
)
overridevirtual

Enable the PID computation for a joint.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
Returns
true on success, false on failure.

Implements yarp::dev::IPidControl.

Definition at line 382 of file xHandControlBoard.cpp.

◆ getAmpStatus() [1/2]

bool yarp::dev::xHandControlBoard::getAmpStatus ( int *  st)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 713 of file xHandControlBoard.cpp.

◆ getAmpStatus() [2/2]

bool yarp::dev::xHandControlBoard::getAmpStatus ( int  j,
int *  v 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 718 of file xHandControlBoard.cpp.

◆ getAxes()

bool yarp::dev::xHandControlBoard::getAxes ( int *  ax)
override

Definition at line 392 of file xHandControlBoard.cpp.

◆ getAxisName()

bool yarp::dev::xHandControlBoard::getAxisName ( int  j,
std::string &  name 
)
overridevirtual

Implements yarp::dev::IAxisInfo.

Definition at line 926 of file xHandControlBoard.cpp.

◆ getCalibratorDevice()

yarp::dev::IRemoteCalibrator * yarp::dev::xHandControlBoard::getCalibratorDevice ( )
overridevirtual

getCalibratorDevice: return the pointer stored with the setCalibratorDevice

Returns
yarp::dev::IRemotizableCalibrator pointer or NULL if not valid.

Reimplemented from yarp::dev::IRemoteCalibrator.

Definition at line 821 of file xHandControlBoard.cpp.

◆ getControlMode()

bool yarp::dev::xHandControlBoard::getControlMode ( int  j,
int *  mode 
)
overridevirtual

Reimplemented from yarp::dev::IControlMode.

Definition at line 1029 of file xHandControlBoard.cpp.

◆ getControlModes() [1/2]

bool yarp::dev::xHandControlBoard::getControlModes ( const int  n_joint,
const int *  joints,
int *  modes 
)
override

Definition at line 1042 of file xHandControlBoard.cpp.

◆ getControlModes() [2/2]

bool yarp::dev::xHandControlBoard::getControlModes ( int *  modes)
override

Definition at line 1035 of file xHandControlBoard.cpp.

◆ getCurrent()

bool yarp::dev::xHandControlBoard::getCurrent ( int  m,
double *  curr 
)
overridevirtual

Get the instantaneous current measurement for a single motor.

Parameters
mmotor number
currpointer to the result value. Value is expressed in amperes.
Returns
true/false on success/failure

Implements yarp::dev::ICurrentControl.

Definition at line 1205 of file xHandControlBoard.cpp.

◆ getCurrentImpedanceLimit()

bool yarp::dev::xHandControlBoard::getCurrentImpedanceLimit ( int  j,
double *  min_stiff,
double *  max_stiff,
double *  min_damp,
double *  max_damp 
)
overridevirtual

Get the current impedance limits for a specific joint.

Returns
success/failure

Implements yarp::dev::IImpedanceControl.

Definition at line 1024 of file xHandControlBoard.cpp.

◆ getCurrentRange()

bool yarp::dev::xHandControlBoard::getCurrentRange ( int  m,
double *  min,
double *  max 
)
overridevirtual

Get the full scale of the current measurement for a given motor (e.g.

-20A +20A) Reference values set by user with methods such as setRefCurrent() should be in this range. This method is not related to the current overload protection methods belonging to the iAmplifierControl interface.

Parameters
mmotor number
minminimum current of the motor m
maxmaximum current of the motor m
Returns
true/false on success/failure

Implements yarp::dev::ICurrentControl.

Definition at line 1215 of file xHandControlBoard.cpp.

◆ getCurrentRanges()

bool yarp::dev::xHandControlBoard::getCurrentRanges ( double *  min,
double *  max 
)
overridevirtual

Get the full scale of the current measurements for all motors motor (e.g.

-20A +20A) Reference values set by user with methods such as setRefCurrent() should be in this range. This method is not related to the current overload protection methods belonging to the iAmplifierControl interface.

Parameters
minpointer to the array that will store minimum currents
maxpointer to the array that will store maximum currents
Returns
true/false on success/failure

Implements yarp::dev::ICurrentControl.

Definition at line 1220 of file xHandControlBoard.cpp.

◆ getCurrents()

bool yarp::dev::xHandControlBoard::getCurrents ( double *  currs)
overridevirtual

Get the instantaneous current measurement for all motors.

Parameters
currspointer to the array that will store the output. Values are expressed in amperes.
Returns
true/false on success/failure

Implements yarp::dev::ICurrentControl.

Definition at line 1210 of file xHandControlBoard.cpp.

◆ getDutyCycle()

bool yarp::dev::xHandControlBoard::getDutyCycle ( int  m,
double *  val 
)
overridevirtual

Gets the current dutycycle of the output of the amplifier (i.e.

pwm value sent to the motor)

Parameters
mmotor number
valpointer to storage for return value, expressed as percentage (-100% +100%)
Returns
true/false on success/failure

Implements yarp::dev::IPWMControl.

Definition at line 1195 of file xHandControlBoard.cpp.

◆ getDutyCycles()

bool yarp::dev::xHandControlBoard::getDutyCycles ( double *  vals)
overridevirtual

Gets the current dutycycle of the output of the amplifier (i.e.

pwm values sent to all motors)

Parameters
valspointer to the vector that will store the values, expressed as percentage (-100% +100%)
Returns
true/false on success/failure

Implements yarp::dev::IPWMControl.

Definition at line 1200 of file xHandControlBoard.cpp.

◆ getEncoder()

bool yarp::dev::xHandControlBoard::getEncoder ( int  j,
double *  v 
)
overridevirtual

Read the value of an encoder.

Parameters
jencoder number
vpointer to storage for the return value
Returns
true/false, upon success/failure (you knew it, uh?)

Implements yarp::dev::IEncoders.

Definition at line 579 of file xHandControlBoard.cpp.

◆ getEncoderAcceleration()

bool yarp::dev::xHandControlBoard::getEncoderAcceleration ( int  j,
double *  spds 
)
overridevirtual

Read the instantaneous acceleration of an axis.

Parameters
jaxis number
spdspointer to the array that will contain the output

Implements yarp::dev::IEncoders.

Definition at line 618 of file xHandControlBoard.cpp.

◆ getEncoderAccelerations()

bool yarp::dev::xHandControlBoard::getEncoderAccelerations ( double *  accs)
overridevirtual

Read the instantaneous acceleration of all axes.

Parameters
accspointer to the array that will contain the output
Returns
true if all goes well, false if anything bad happens.

Implements yarp::dev::IEncoders.

Definition at line 623 of file xHandControlBoard.cpp.

◆ getEncoders()

bool yarp::dev::xHandControlBoard::getEncoders ( double *  encs)
overridevirtual

Read the position of all axes.

Parameters
encspointer to the array that will contain the output
Returns
true/false on success/failure

Implements yarp::dev::IEncoders.

Definition at line 586 of file xHandControlBoard.cpp.

◆ getEncoderSpeed()

bool yarp::dev::xHandControlBoard::getEncoderSpeed ( int  j,
double *  sp 
)
overridevirtual

Read the istantaneous speed of an axis.

Parameters
jaxis number
sppointer to storage for the output
Returns
true if successful, false ... otherwise.

Implements yarp::dev::IEncoders.

Definition at line 608 of file xHandControlBoard.cpp.

◆ getEncoderSpeeds()

bool yarp::dev::xHandControlBoard::getEncoderSpeeds ( double *  spds)
overridevirtual

Read the instantaneous speed of all axes.

Parameters
spdspointer to storage for the output values
Returns
guess what? (true/false on success or failure).

Implements yarp::dev::IEncoders.

Definition at line 613 of file xHandControlBoard.cpp.

◆ getEncodersTimed()

bool yarp::dev::xHandControlBoard::getEncodersTimed ( double *  encs,
double *  time 
)
overridevirtual

Read the instantaneous acceleration of all axes.

Parameters
encspointer to the array that will contain the output
timepointer to the array that will contain individual timestamps
Returns
true if all goes well, false if anything bad happens.

Implements yarp::dev::IEncodersTimed.

Definition at line 593 of file xHandControlBoard.cpp.

◆ getEncoderTimed()

bool yarp::dev::xHandControlBoard::getEncoderTimed ( int  j,
double *  encs,
double *  time 
)
overridevirtual

Read the instantaneous acceleration of all axes.

Parameters
jaxis index
encsencoder value (pointer to)
timecorresponding timestamp (pointer to)
Returns
true if all goes well, false if anything bad happens.

Implements yarp::dev::IEncodersTimed.

Definition at line 603 of file xHandControlBoard.cpp.

◆ getGearboxRatio()

bool yarp::dev::xHandControlBoard::getGearboxRatio ( int  m,
double *  val 
)
overridevirtual

Get the gearbox ratio for a specific motor.

Parameters
mmotor number
valretrieved gearbox ratio
Returns
true/false

Implements yarp::dev::IMotor.

Definition at line 916 of file xHandControlBoard.cpp.

◆ getImpedance()

bool yarp::dev::xHandControlBoard::getImpedance ( int  j,
double *  stiffness,
double *  damping 
)
overridevirtual

Get current impedance gains (stiffness,damping,offset) for a specific joint.

Returns
success/failure

Implements yarp::dev::IImpedanceControl.

Definition at line 1014 of file xHandControlBoard.cpp.

◆ getImpedanceOffset()

bool yarp::dev::xHandControlBoard::getImpedanceOffset ( int  j,
double *  offset 
)
overridevirtual

Get current force Offset for a specific joint.

Returns
success/failure

Implements yarp::dev::IImpedanceControl.

Definition at line 1019 of file xHandControlBoard.cpp.

◆ getInteractionMode()

bool yarp::dev::xHandControlBoard::getInteractionMode ( int  j,
yarp::dev::InteractionModeEnum *  mode 
)
override

Definition at line 1145 of file xHandControlBoard.cpp.

◆ getInteractionModes() [1/2]

bool yarp::dev::xHandControlBoard::getInteractionModes ( int  n_joints,
int *  joints,
yarp::dev::InteractionModeEnum *  modes 
)
override

Definition at line 1150 of file xHandControlBoard.cpp.

◆ getInteractionModes() [2/2]

bool yarp::dev::xHandControlBoard::getInteractionModes ( yarp::dev::InteractionModeEnum *  modes)
override

Definition at line 1155 of file xHandControlBoard.cpp.

◆ getJointType()

bool yarp::dev::xHandControlBoard::getJointType ( int  j,
yarp::dev::JointTypeEnum &  type 
)
overridevirtual

Reimplemented from yarp::dev::IAxisInfo.

Definition at line 932 of file xHandControlBoard.cpp.

◆ getLastInputStamp()

yarp::os::Stamp yarp::dev::xHandControlBoard::getLastInputStamp ( )
overridevirtual

Return the time stamp relative to the last acquisition.

Implements yarp::dev::IPreciselyTimed.

Definition at line 1118 of file xHandControlBoard.cpp.

◆ getLastJointFault()

bool yarp::dev::xHandControlBoard::getLastJointFault ( int  j,
int &  fault,
std::string &  message 
)
overridevirtual

Implements yarp::dev::IJointFault.

Definition at line 544 of file xHandControlBoard.cpp.

◆ getLimits()

bool yarp::dev::xHandControlBoard::getLimits ( int  j,
double *  min,
double *  max 
)
override

Definition at line 780 of file xHandControlBoard.cpp.

◆ getMaxCurrent()

bool yarp::dev::xHandControlBoard::getMaxCurrent ( int  j,
double *  v 
)
overridevirtual

Returns the maximum electric current allowed for a given motor.

Exceeding this value will trigger instantaneous hardware fault.

Parameters
jmotor number
vthe return value
Returns
probably true, might return false in bad times

Implements yarp::dev::IAmplifierControl.

Definition at line 728 of file xHandControlBoard.cpp.

◆ getMotorEncoder()

bool yarp::dev::xHandControlBoard::getMotorEncoder ( int  m,
double *  v 
)
overridevirtual

Read the value of a motor encoder.

Parameters
mmotor encoder number
vpointer to storage for the return value
Returns
true/false

Implements yarp::dev::IMotorEncoders.

Definition at line 663 of file xHandControlBoard.cpp.

◆ getMotorEncoderAcceleration()

bool yarp::dev::xHandControlBoard::getMotorEncoderAcceleration ( int  m,
double *  acc 
)
overridevirtual

Read the instantaneous acceleration of a motor encoder.

Parameters
mmotor number
accpointer to the array that will contain the output
Returns
true if successful, false otherwise.

Implements yarp::dev::IMotorEncoders.

Definition at line 693 of file xHandControlBoard.cpp.

◆ getMotorEncoderAccelerations()

bool yarp::dev::xHandControlBoard::getMotorEncoderAccelerations ( double *  accs)
overridevirtual

Read the instantaneous acceleration of all motor encoders.

Parameters
accspointer to the array that will contain the output
Returns
true if successful, false otherwise.

Implements yarp::dev::IMotorEncoders.

Definition at line 698 of file xHandControlBoard.cpp.

◆ getMotorEncoderCountsPerRevolution()

bool yarp::dev::xHandControlBoard::getMotorEncoderCountsPerRevolution ( int  m,
double *  cpr 
)
overridevirtual

Gets number of counts per revolution for motor encoder m.

Parameters
mmotor number
cprvals pointer to the new value
Returns
true/false

Implements yarp::dev::IMotorEncoders.

Definition at line 648 of file xHandControlBoard.cpp.

◆ getMotorEncoders()

bool yarp::dev::xHandControlBoard::getMotorEncoders ( double *  encs)
overridevirtual

Read the position of all motor encoders.

Parameters
encspointer to the array that will contain the output
Returns
true/false

Implements yarp::dev::IMotorEncoders.

Definition at line 668 of file xHandControlBoard.cpp.

◆ getMotorEncoderSpeed()

bool yarp::dev::xHandControlBoard::getMotorEncoderSpeed ( int  m,
double *  sp 
)
overridevirtual

Read the instantaneous speed of a motor encoder.

Parameters
mmotor number
sppointer to storage for the output
Returns
true if successful, false otherwise.

Implements yarp::dev::IMotorEncoders.

Definition at line 683 of file xHandControlBoard.cpp.

◆ getMotorEncoderSpeeds()

bool yarp::dev::xHandControlBoard::getMotorEncoderSpeeds ( double *  spds)
overridevirtual

Read the instantaneous speed of all motor encoders.

Parameters
spdspointer to storage for the output values
Returns
true if successful, false otherwise.

Implements yarp::dev::IMotorEncoders.

Definition at line 688 of file xHandControlBoard.cpp.

◆ getMotorEncodersTimed()

bool yarp::dev::xHandControlBoard::getMotorEncodersTimed ( double *  encs,
double *  time 
)
overridevirtual

Read the instantaneous position of all motor encoders.

Parameters
encspointer to the array that will contain the output
timepointer to the array that will contain individual timestamps
Returns
true if successful, false otherwise.

Implements yarp::dev::IMotorEncoders.

Definition at line 673 of file xHandControlBoard.cpp.

◆ getMotorEncoderTimed()

bool yarp::dev::xHandControlBoard::getMotorEncoderTimed ( int  m,
double *  encs,
double *  time 
)
overridevirtual

Read the instantaneous position of a motor encoder.

Parameters
mmotor index
encsencoder value (pointer to)
timecorresponding timestamp (pointer to)
Returns
true if successful, false otherwise.

Implements yarp::dev::IMotorEncoders.

Definition at line 678 of file xHandControlBoard.cpp.

◆ getMotorTorqueParams()

bool yarp::dev::xHandControlBoard::getMotorTorqueParams ( int  j,
yarp::dev::MotorTorqueParameters *  params 
)
overridevirtual

Get a subset of motor parameters (bemf, ktau etc) useful for torque control.

Parameters
jjoint number
paramsa struct containing the motor parameters to be retrieved
Returns
true/false on success/failure

Implements yarp::dev::ITorqueControl.

Definition at line 974 of file xHandControlBoard.cpp.

◆ getNominalCurrent()

bool yarp::dev::xHandControlBoard::getNominalCurrent ( int  m,
double *  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 733 of file xHandControlBoard.cpp.

◆ getNumberOfMotorEncoders()

bool yarp::dev::xHandControlBoard::getNumberOfMotorEncoders ( int *  num)
overridevirtual

Get the number of available motor encoders.

Parameters
mpointer to a value representing the number of available motor encoders.
Returns
true/false

Implements yarp::dev::IMotorEncoders.

Definition at line 628 of file xHandControlBoard.cpp.

◆ getNumberOfMotors()

bool yarp::dev::xHandControlBoard::getNumberOfMotors ( int *  number)
overridevirtual

Retrieves the number of controlled motors from the current physical interface.

Parameters
numberreturns the number of controlled motors.
Returns
true/false on success/failure

Implements yarp::dev::IPWMControl.

Definition at line 891 of file xHandControlBoard.cpp.

◆ getPeakCurrent()

bool yarp::dev::xHandControlBoard::getPeakCurrent ( int  m,
double *  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 743 of file xHandControlBoard.cpp.

◆ getPid()

bool yarp::dev::xHandControlBoard::getPid ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j,
yarp::dev::Pid *  pid 
)
overridevirtual

Get current PID value for a specific joint.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
pidpointer to storage for the return value.
Returns
success/failure

Implements yarp::dev::IPidControl.

Definition at line 305 of file xHandControlBoard.cpp.

◆ getPidError()

bool yarp::dev::xHandControlBoard::getPidError ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j,
double *  err 
)
overridevirtual

Get the current error for a joint.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
errpointer to the storage for the return value
Returns
true/false on success failure

Implements yarp::dev::IPidControl.

Definition at line 280 of file xHandControlBoard.cpp.

◆ getPidErrorLimit()

bool yarp::dev::xHandControlBoard::getPidErrorLimit ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j,
double *  limit 
)
overridevirtual

Get the error limit for the controller on a specific joint.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
limitpointer to storage
Returns
success/failure

Implements yarp::dev::IPidControl.

Definition at line 362 of file xHandControlBoard.cpp.

◆ getPidErrorLimits()

bool yarp::dev::xHandControlBoard::getPidErrorLimits ( const yarp::dev::PidControlTypeEnum &  pidtype,
double *  limits 
)
overridevirtual

Get the error limit for all controllers.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
limitspointer to the array that will store the output
Returns
success or failure

Implements yarp::dev::IPidControl.

Definition at line 367 of file xHandControlBoard.cpp.

◆ getPidErrors()

bool yarp::dev::xHandControlBoard::getPidErrors ( const yarp::dev::PidControlTypeEnum &  pidtype,
double *  errs 
)
overridevirtual

Get the error of all joints.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
errspointer to the vector that will store the errors

Implements yarp::dev::IPidControl.

Definition at line 285 of file xHandControlBoard.cpp.

◆ getPidOutput()

bool yarp::dev::xHandControlBoard::getPidOutput ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j,
double *  out 
)
overridevirtual

Get the output of the controller (e.g.

pwm value)

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
outpointer to storage for return value
Returns
success/failure

Implements yarp::dev::IPidControl.

Definition at line 290 of file xHandControlBoard.cpp.

◆ getPidOutputs()

bool yarp::dev::xHandControlBoard::getPidOutputs ( const yarp::dev::PidControlTypeEnum &  pidtype,
double *  outs 
)
overridevirtual

Get the output of the controllers (e.g.

pwm value)

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
outspointer to the vector that will store the output values

Implements yarp::dev::IPidControl.

Definition at line 295 of file xHandControlBoard.cpp.

◆ getPidReference()

bool yarp::dev::xHandControlBoard::getPidReference ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j,
double *  ref 
)
overridevirtual

Get the current reference of the PID controller for a specific joint.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
refpointer to storage for return value
Returns
reference value

Implements yarp::dev::IPidControl.

Definition at line 352 of file xHandControlBoard.cpp.

◆ getPidReferences()

bool yarp::dev::xHandControlBoard::getPidReferences ( const yarp::dev::PidControlTypeEnum &  pidtype,
double *  refs 
)
overridevirtual

Get the current reference of all PID controllers.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
refsvector that will store the output.

Implements yarp::dev::IPidControl.

Definition at line 357 of file xHandControlBoard.cpp.

◆ getPids()

bool yarp::dev::xHandControlBoard::getPids ( const yarp::dev::PidControlTypeEnum &  pidtype,
yarp::dev::Pid *  pids 
)
overridevirtual

Get current PID value for a specific joint.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
pidsvector that will store the values of the pids.
Returns
success/failure

Implements yarp::dev::IPidControl.

Definition at line 328 of file xHandControlBoard.cpp.

◆ getPowerSupplyVoltage()

bool yarp::dev::xHandControlBoard::getPowerSupplyVoltage ( int  m,
double *  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 768 of file xHandControlBoard.cpp.

◆ getPWM()

bool yarp::dev::xHandControlBoard::getPWM ( int  m,
double *  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 753 of file xHandControlBoard.cpp.

◆ getPWMLimit()

bool yarp::dev::xHandControlBoard::getPWMLimit ( int  m,
double *  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 758 of file xHandControlBoard.cpp.

◆ getRefAcceleration()

bool yarp::dev::xHandControlBoard::getRefAcceleration ( int  j,
double *  acc 
)
override

Definition at line 514 of file xHandControlBoard.cpp.

◆ getRefAccelerations() [1/2]

bool yarp::dev::xHandControlBoard::getRefAccelerations ( const int  n_joints,
const int *  joints,
double *  accs 
)
override

Definition at line 524 of file xHandControlBoard.cpp.

◆ getRefAccelerations() [2/2]

bool yarp::dev::xHandControlBoard::getRefAccelerations ( double *  accs)
override

Definition at line 519 of file xHandControlBoard.cpp.

◆ getRefCurrent()

bool yarp::dev::xHandControlBoard::getRefCurrent ( int  m,
double *  curr 
)
overridevirtual

Get the reference value of the current for a single motor.

Parameters
mmotor number
currthe current reference value for motor m. Value is expressed in amperes.
Returns
true/false on success/failure

Implements yarp::dev::ICurrentControl.

Definition at line 1245 of file xHandControlBoard.cpp.

◆ getRefCurrents()

bool yarp::dev::xHandControlBoard::getRefCurrents ( double *  currs)
overridevirtual

Get the reference value of the currents for all motors.

Parameters
currspointer to the array to be filled with reference current values. Values are expressed in amperes.
Returns
true/false on success/failure

Implements yarp::dev::ICurrentControl.

Definition at line 1240 of file xHandControlBoard.cpp.

◆ getRefDutyCycle()

bool yarp::dev::xHandControlBoard::getRefDutyCycle ( int  m,
double *  ref 
)
overridevirtual

Gets the last reference sent using the setRefDutyCycle function.

Parameters
mmotor number
refpointer to storage for return value, expressed as percentage (-100% +100%)
Returns
true/false on success/failure

Implements yarp::dev::IPWMControl.

Definition at line 1185 of file xHandControlBoard.cpp.

◆ getRefDutyCycles()

bool yarp::dev::xHandControlBoard::getRefDutyCycles ( double *  refs)
overridevirtual

Gets the last reference sent using the setRefDutyCycles function.

Parameters
refspointer to the vector that will store the values, expressed as percentage (-100% +100%)
Returns
true/false on success/failure

Implements yarp::dev::IPWMControl.

Definition at line 1190 of file xHandControlBoard.cpp.

◆ getRefPosition()

bool yarp::dev::xHandControlBoard::getRefPosition ( const int  joint,
double *  ref 
)
overridevirtual

Get the last position reference for the specified axis.

This is the dual of setPositionsRaw and shall return only values sent using IPositionDirect interface. If other interfaces like IPositionControl are implemented by the device, this call must ignore their values, i.e. this call must never return a reference sent using IPositionControl::PositionMove.

Parameters
reflast reference sent using setPosition(s) functions
Returns
true/false on success/failure

Implements yarp::dev::IPositionDirect.

Definition at line 1103 of file xHandControlBoard.cpp.

◆ getRefPositions() [1/2]

bool yarp::dev::xHandControlBoard::getRefPositions ( const int  n_joint,
const int *  joints,
double *  refs 
)
overridevirtual

Get the last position reference for the specified group of axes.

This is the dual of setPositionsRaw and shall return only values sent using IPositionDirect interface. If other interfaces like IPositionControl are implemented by the device, this call must ignore their values, i.e. this call must never return a reference sent using IPositionControl::PositionMove.

Parameters
refarray containing last reference sent using setPosition(s) functions
Returns
true/false on success/failure

Implements yarp::dev::IPositionDirect.

Definition at line 1113 of file xHandControlBoard.cpp.

◆ getRefPositions() [2/2]

bool yarp::dev::xHandControlBoard::getRefPositions ( double *  refs)
overridevirtual

Get the last position reference for all axes.

This is the dual of setPositionsRaw and shall return only values sent using IPositionDirect interface. If other interfaces like IPositionControl are implemented by the device, this call must ignore their values, i.e. this call must never return a reference sent using IPositionControl::PositionMove.

Parameters
refarray containing last reference sent using setPosition(s) functions
Returns
true/false on success/failure

Implements yarp::dev::IPositionDirect.

Definition at line 1108 of file xHandControlBoard.cpp.

◆ getRefSpeed()

bool yarp::dev::xHandControlBoard::getRefSpeed ( int  j,
double *  ref 
)
override

Definition at line 497 of file xHandControlBoard.cpp.

◆ getRefSpeeds() [1/2]

bool yarp::dev::xHandControlBoard::getRefSpeeds ( const int  n_joints,
const int *  joints,
double *  spds 
)
override

Definition at line 509 of file xHandControlBoard.cpp.

◆ getRefSpeeds() [2/2]

bool yarp::dev::xHandControlBoard::getRefSpeeds ( double *  spds)
override

Definition at line 504 of file xHandControlBoard.cpp.

◆ getRefTorque()

bool yarp::dev::xHandControlBoard::getRefTorque ( int  j,
double *  t 
)
overridevirtual

Get the reference value of the torque for a given joint.

This is NOT the feedback (see getTorque instead).

Parameters
jjoint number
tthe returned reference torque of joint j
Returns
true/false on success/failure

Implements yarp::dev::ITorqueControl.

Definition at line 952 of file xHandControlBoard.cpp.

◆ getRefTorques()

bool yarp::dev::xHandControlBoard::getRefTorques ( double *  t)
overridevirtual

Get the reference value of the torque for all joints.

This is NOT the feedback (see getTorques instead).

Parameters
tpointer to the array of torque values
Returns
true/false on success/failure

Implements yarp::dev::ITorqueControl.

Definition at line 947 of file xHandControlBoard.cpp.

◆ getRefVelocities() [1/2]

bool yarp::dev::xHandControlBoard::getRefVelocities ( const int  n_joint,
const int *  joints,
double *  vels 
)
override

Definition at line 1140 of file xHandControlBoard.cpp.

◆ getRefVelocities() [2/2]

bool yarp::dev::xHandControlBoard::getRefVelocities ( double *  vels)
override

Definition at line 1135 of file xHandControlBoard.cpp.

◆ getRefVelocity()

bool yarp::dev::xHandControlBoard::getRefVelocity ( const int  joint,
double *  vel 
)
override

Definition at line 1128 of file xHandControlBoard.cpp.

◆ getRemoteVariable()

bool yarp::dev::xHandControlBoard::getRemoteVariable ( std::string  key,
yarp::os::Bottle &  val 
)
overridevirtual

Implements yarp::dev::IRemoteVariables.

Definition at line 801 of file xHandControlBoard.cpp.

◆ getRemoteVariablesList()

bool yarp::dev::xHandControlBoard::getRemoteVariablesList ( yarp::os::Bottle *  listOfKeys)
overridevirtual

Implements yarp::dev::IRemoteVariables.

Definition at line 811 of file xHandControlBoard.cpp.

◆ getTargetPosition()

bool yarp::dev::xHandControlBoard::getTargetPosition ( const int  joint,
double *  ref 
)
overridevirtual

Get the last position reference for the specified axis.

This is the dual of PositionMove and shall return only values sent using IPositionControl interface. If other interfaces like IPositionDirect are implemented by the device, this call must ignore their values, i.e. this call must never return a reference sent using IPositionDirect::SetPosition

Parameters
reflast reference sent using PositionMove functions
Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 413 of file xHandControlBoard.cpp.

◆ getTargetPositions() [1/2]

bool yarp::dev::xHandControlBoard::getTargetPositions ( const int  n_joint,
const int *  joints,
double *  refs 
)
overridevirtual

Get the last position reference for the specified group of axes.

This is the dual of PositionMove and shall return only values sent using IPositionControl interface. If other interfaces like IPositionDirect are implemented by the device, this call must ignore their values, i.e. this call must never return a reference sent using IPositionDirect::SetPosition

Parameters
reflast reference sent using PositionMove functions
Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 427 of file xHandControlBoard.cpp.

◆ getTargetPositions() [2/2]

bool yarp::dev::xHandControlBoard::getTargetPositions ( double *  refs)
overridevirtual

Get the last position reference for all axes.

This is the dual of PositionMove and shall return only values sent using IPositionControl interface. If other interfaces like IPositionDirect are implemented by the device, this call must ignore their values, i.e. this call must never return a reference sent using IPositionDirect::SetPosition

Parameters
reflast reference sent using PositionMove functions
Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 420 of file xHandControlBoard.cpp.

◆ getTemperature()

bool yarp::dev::xHandControlBoard::getTemperature ( int  m,
double *  val 
)
overridevirtual

Get temperature of a motor.

Parameters
mmotor number
valretrieved motor temperature
Returns
true/false

Implements yarp::dev::IMotor.

Definition at line 896 of file xHandControlBoard.cpp.

◆ getTemperatureLimit()

bool yarp::dev::xHandControlBoard::getTemperatureLimit ( int  m,
double *  temp 
)
overridevirtual

Retrieves the current temperature limit for a specific motor.

The specific behavior of the motor when the temperature limit is exceeded depends on the implementation (power off recommended)

Parameters
mmotor number
tempthe current temperature limit.
Returns
true/false

Implements yarp::dev::IMotor.

Definition at line 906 of file xHandControlBoard.cpp.

◆ getTemperatures()

bool yarp::dev::xHandControlBoard::getTemperatures ( double *  vals)
overridevirtual

Get temperature of all the motors.

Parameters
valspointer to an array containing all motor temperatures
Returns
true/false

Implements yarp::dev::IMotor.

Definition at line 901 of file xHandControlBoard.cpp.

◆ getTorque()

bool yarp::dev::xHandControlBoard::getTorque ( int  j,
double *  t 
)
overridevirtual

Get the value of the torque on a given joint (this is the feedback if you have a torque sensor).

Parameters
jjoint number
tpointer to the result value
Returns
true/false on success/failure

Implements yarp::dev::ITorqueControl.

Definition at line 994 of file xHandControlBoard.cpp.

◆ getTorqueRange()

bool yarp::dev::xHandControlBoard::getTorqueRange ( int  j,
double *  min,
double *  max 
)
overridevirtual

Get the full scale of the torque sensor of a given joint.

Parameters
jjoint number
minminimum torque of the joint j
maxmaximum torque of the joint j
Returns
true/false on success/failure

Implements yarp::dev::ITorqueControl.

Definition at line 1004 of file xHandControlBoard.cpp.

◆ getTorqueRanges()

bool yarp::dev::xHandControlBoard::getTorqueRanges ( double *  min,
double *  max 
)
overridevirtual

Get the full scale of the torque sensors of all joints.

Parameters
minpointer to the array that will store minimum torques of the joints
maxpointer to the array that will store maximum torques of the joints
Returns
true/false on success/failure

Implements yarp::dev::ITorqueControl.

Definition at line 1009 of file xHandControlBoard.cpp.

◆ getTorques()

bool yarp::dev::xHandControlBoard::getTorques ( double *  t)
overridevirtual

Get the value of the torque for all joints (this is the feedback if you have torque sensors).

Parameters
tpointer to the array that will store the output
Returns
true/false on success/failure

Implements yarp::dev::ITorqueControl.

Definition at line 999 of file xHandControlBoard.cpp.

◆ getVelLimits()

bool yarp::dev::xHandControlBoard::getVelLimits ( int  axis,
double *  min,
double *  max 
)
overridevirtual

Get the software speed limits for a particular axis.

Parameters
axisjoint number
minpointer to store the value of the lower limit
maxpointer to store the value of the upper limit
Returns
true if everything goes fine, false otherwise.

Implements yarp::dev::IControlLimits.

Definition at line 794 of file xHandControlBoard.cpp.

◆ homingSingleJoint()

bool yarp::dev::xHandControlBoard::homingSingleJoint ( int  j)
overridevirtual

homingSingleJoint: call the homing procedure for a single joint

Parameters
jjoint to be calibrated
Returns
true if homing was successful, false otherwise

Implements yarp::dev::IRemoteCalibrator.

Definition at line 836 of file xHandControlBoard.cpp.

◆ homingWholePart()

bool yarp::dev::xHandControlBoard::homingWholePart ( )
overridevirtual

homingWholePart: call the homing procedure for a the whole part/device

Returns
true if homing was successful, false otherwise

Implements yarp::dev::IRemoteCalibrator.

Definition at line 841 of file xHandControlBoard.cpp.

◆ isCalibratorDevicePresent()

bool yarp::dev::xHandControlBoard::isCalibratorDevicePresent ( bool *  isCalib)
overridevirtual

isCalibratorDevicePresent: check if a calibrator device has been set

Returns
true if a valid calibrator device has been found

Reimplemented from yarp::dev::IRemoteCalibrator.

Definition at line 816 of file xHandControlBoard.cpp.

◆ isPidEnabled()

bool yarp::dev::xHandControlBoard::isPidEnabled ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j,
bool *  enabled 
)
override

Definition at line 387 of file xHandControlBoard.cpp.

◆ open()

bool yarp::dev::xHandControlBoard::open ( yarp::os::Searchable &  config)
overridevirtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 22 of file xHandControlBoard.cpp.

◆ parkSingleJoint()

bool yarp::dev::xHandControlBoard::parkSingleJoint ( int  j,
bool  _wait = true 
)
overridevirtual

parkSingleJoint(): start the parking procedure for the single joint

Returns
true if successful

Implements yarp::dev::IRemoteCalibrator.

Definition at line 846 of file xHandControlBoard.cpp.

◆ parkWholePart()

bool yarp::dev::xHandControlBoard::parkWholePart ( )
overridevirtual

parkWholePart: start the parking procedure for the whole part

Returns
true if successful

Implements yarp::dev::IRemoteCalibrator.

Definition at line 851 of file xHandControlBoard.cpp.

◆ positionMove() [1/3]

bool yarp::dev::xHandControlBoard::positionMove ( const double *  refs)
overridevirtual

Set new reference point for all axes.

Parameters
refsarray, new reference points.
Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 403 of file xHandControlBoard.cpp.

◆ positionMove() [2/3]

bool yarp::dev::xHandControlBoard::positionMove ( const int  n_joint,
const int *  joints,
const double *  refs 
)
overridevirtual

Set new reference point for a subset of joints.

Parameters
jointspointer to the array of joint numbers
refspointer to the array specifying the new reference points
Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 408 of file xHandControlBoard.cpp.

◆ positionMove() [3/3]

bool yarp::dev::xHandControlBoard::positionMove ( int  j,
double  ref 
)
overridevirtual

Set new reference point for a single axis.

Parameters
jjoint number
refspecifies the new ref point
Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 398 of file xHandControlBoard.cpp.

◆ quitCalibrate()

bool yarp::dev::xHandControlBoard::quitCalibrate ( )
overridevirtual

quitCalibrate: interrupt the calibration procedure

Returns
true if successful

Implements yarp::dev::IRemoteCalibrator.

Definition at line 856 of file xHandControlBoard.cpp.

◆ quitPark()

bool yarp::dev::xHandControlBoard::quitPark ( )
overridevirtual

quitPark: interrupt the park procedure

Returns
true if successful

Implements yarp::dev::IRemoteCalibrator.

Definition at line 861 of file xHandControlBoard.cpp.

◆ relativeMove() [1/3]

bool yarp::dev::xHandControlBoard::relativeMove ( const double *  deltas)
overridevirtual

Set relative position, all joints.

Parameters
deltaspointer to the relative commands
Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 439 of file xHandControlBoard.cpp.

◆ relativeMove() [2/3]

bool yarp::dev::xHandControlBoard::relativeMove ( const int  n_joint,
const int *  joints,
const double *  deltas 
)
overridevirtual

Set relative position for a subset of joints.

Parameters
jointspointer to the array of joint numbers
deltaspointer to the array of relative commands
Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 444 of file xHandControlBoard.cpp.

◆ relativeMove() [3/3]

bool yarp::dev::xHandControlBoard::relativeMove ( int  j,
double  delta 
)
overridevirtual

Set relative position.

The command is relative to the current position of the axis.

Parameters
jjoint axis number
deltarelative command
Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 434 of file xHandControlBoard.cpp.

◆ resetEncoder()

bool yarp::dev::xHandControlBoard::resetEncoder ( int  j)
overridevirtual

Reset encoder, single joint.

Set the encoder value to zero

Parameters
jencoder number
Returns
true/false

Implements yarp::dev::IEncoders.

Definition at line 559 of file xHandControlBoard.cpp.

◆ resetEncoders()

bool yarp::dev::xHandControlBoard::resetEncoders ( )
overridevirtual

Reset encoders.

Set the encoders value to zero

Returns
true/false

Implements yarp::dev::IEncoders.

Definition at line 564 of file xHandControlBoard.cpp.

◆ resetMotorEncoder()

bool yarp::dev::xHandControlBoard::resetMotorEncoder ( int  m)
overridevirtual

Reset motor encoder, single motor.

Set the encoder value to zero.

Parameters
mmotor number
Returns
true/false

Implements yarp::dev::IMotorEncoders.

Definition at line 633 of file xHandControlBoard.cpp.

◆ resetMotorEncoders()

bool yarp::dev::xHandControlBoard::resetMotorEncoders ( )
overridevirtual

Reset motor encoders.

Set the motor encoders value to zero.

Returns
true/false

Implements yarp::dev::IMotorEncoders.

Definition at line 638 of file xHandControlBoard.cpp.

◆ resetPid()

bool yarp::dev::xHandControlBoard::resetPid ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j 
)
overridevirtual

Reset the controller of a given joint, usually sets the current status of the joint as the reference value for the PID, and resets the integrator.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
Returns
true on success, false on failure.

Implements yarp::dev::IPidControl.

Definition at line 372 of file xHandControlBoard.cpp.

◆ run()

void yarp::dev::xHandControlBoard::run ( )
overridevirtual

Loop function.

This is the thread itself. The thread calls the run() function every <period> ms. At the end of each run, the thread will sleep the amounth of time required, taking into account the time spent inside the loop function. Example: requested period is 10ms, the run() function take 3ms to be executed, the thread will sleep for 7ms.

Note: after each run is completed, the thread will call a yield() in order to facilitate other threads to run.

Implements yarp::os::PeriodicThread.

Definition at line 1250 of file xHandControlBoard.cpp.

◆ setCalibrationParameters()

bool yarp::dev::xHandControlBoard::setCalibrationParameters ( int  axis,
const yarp::dev::CalibrationParameters &  params 
)
overridevirtual

Start calibration, this method is very often platform specific.

Returns
true/false on success failure

Implements yarp::dev::IControlCalibration.

Definition at line 871 of file xHandControlBoard.cpp.

◆ setControlMode()

bool yarp::dev::xHandControlBoard::setControlMode ( const int  j,
const int  mode 
)
overridevirtual

Reimplemented from yarp::dev::IControlMode.

Definition at line 1049 of file xHandControlBoard.cpp.

◆ setControlModes() [1/2]

bool yarp::dev::xHandControlBoard::setControlModes ( const int  n_joints,
const int *  joints,
int *  modes 
)
override

Definition at line 1070 of file xHandControlBoard.cpp.

◆ setControlModes() [2/2]

bool yarp::dev::xHandControlBoard::setControlModes ( int *  modes)
override

Definition at line 1077 of file xHandControlBoard.cpp.

◆ setEncoder()

bool yarp::dev::xHandControlBoard::setEncoder ( int  j,
double  val 
)
overridevirtual

Set the value of the encoder for a given joint.

Parameters
jencoder number
valnew value
Returns
true/false

Implements yarp::dev::IEncoders.

Definition at line 569 of file xHandControlBoard.cpp.

◆ setEncoders()

bool yarp::dev::xHandControlBoard::setEncoders ( const double *  vals)
overridevirtual

Set the value of all encoders.

Parameters
valspointer to the new values
Returns
true/false

Implements yarp::dev::IEncoders.

Definition at line 574 of file xHandControlBoard.cpp.

◆ setGearboxRatio()

bool yarp::dev::xHandControlBoard::setGearboxRatio ( int  m,
const double  val 
)
overridevirtual

Set the gearbox ratio for a specific motor.

Parameters
mmotor number
gearboxratio to be set
Returns
true/false

Implements yarp::dev::IMotor.

Definition at line 921 of file xHandControlBoard.cpp.

◆ setImpedance()

bool yarp::dev::xHandControlBoard::setImpedance ( int  j,
double  stiffness,
double  damping 
)
overridevirtual

Set current impedance gains (stiffness,damping) for a specific joint.

Returns
success/failure

Implements yarp::dev::IImpedanceControl.

Definition at line 984 of file xHandControlBoard.cpp.

◆ setImpedanceOffset()

bool yarp::dev::xHandControlBoard::setImpedanceOffset ( int  j,
double  offset 
)
overridevirtual

Set current force Offset for a specific joint.

Returns
success/failure

Implements yarp::dev::IImpedanceControl.

Definition at line 989 of file xHandControlBoard.cpp.

◆ setInteractionMode()

bool yarp::dev::xHandControlBoard::setInteractionMode ( int  axis,
yarp::dev::InteractionModeEnum  mode 
)
overridevirtual

Set the interaction mode of the robot, values can be stiff or compliant.

Please note that some robot may not implement certain types of interaction, so always check the return value.

Parameters
axisjoint number
modethe desired interaction mode
Returns
true or false on success or failure.

Implements yarp::dev::IInteractionMode.

Definition at line 1160 of file xHandControlBoard.cpp.

◆ setInteractionModes() [1/2]

bool yarp::dev::xHandControlBoard::setInteractionModes ( int  n_joints,
int *  joints,
yarp::dev::InteractionModeEnum *  modes 
)
override

Definition at line 1165 of file xHandControlBoard.cpp.

◆ setInteractionModes() [2/2]

bool yarp::dev::xHandControlBoard::setInteractionModes ( yarp::dev::InteractionModeEnum *  modes)
override

Definition at line 1170 of file xHandControlBoard.cpp.

◆ setLimits()

bool yarp::dev::xHandControlBoard::setLimits ( int  j,
double  min,
double  max 
)
override

Definition at line 773 of file xHandControlBoard.cpp.

◆ setMaxCurrent()

bool yarp::dev::xHandControlBoard::setMaxCurrent ( int  j,
double  v 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 723 of file xHandControlBoard.cpp.

◆ setMotorEncoder()

bool yarp::dev::xHandControlBoard::setMotorEncoder ( int  m,
const double  val 
)
overridevirtual

Set the value of the motor encoder for a given motor.

Parameters
mmotor number
valnew value
Returns
true/false

Implements yarp::dev::IMotorEncoders.

Definition at line 653 of file xHandControlBoard.cpp.

◆ setMotorEncoderCountsPerRevolution()

bool yarp::dev::xHandControlBoard::setMotorEncoderCountsPerRevolution ( int  m,
const double  cpr 
)
overridevirtual

Sets number of counts per revolution for motor encoder m.

Parameters
mmotor number
cprnew value
Returns
true/false

Implements yarp::dev::IMotorEncoders.

Definition at line 643 of file xHandControlBoard.cpp.

◆ setMotorEncoders()

bool yarp::dev::xHandControlBoard::setMotorEncoders ( const double *  vals)
overridevirtual

Set the value of all motor encoders.

Parameters
valspointer to the new values
Returns
true/false

Implements yarp::dev::IMotorEncoders.

Definition at line 658 of file xHandControlBoard.cpp.

◆ setMotorTorqueParams()

bool yarp::dev::xHandControlBoard::setMotorTorqueParams ( int  j,
const yarp::dev::MotorTorqueParameters  params 
)
overridevirtual

Set a subset of motor parameters (bemf, ktau etc) useful for torque control.

Parameters
jjoint number
paramsa struct containing the motor parameters to be set
Returns
true/false on success/failure

Implements yarp::dev::ITorqueControl.

Definition at line 979 of file xHandControlBoard.cpp.

◆ setNominalCurrent()

bool yarp::dev::xHandControlBoard::setNominalCurrent ( int  m,
const double  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 738 of file xHandControlBoard.cpp.

◆ setPeakCurrent()

bool yarp::dev::xHandControlBoard::setPeakCurrent ( int  m,
const double  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 748 of file xHandControlBoard.cpp.

◆ setPid()

bool yarp::dev::xHandControlBoard::setPid ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j,
const yarp::dev::Pid &  pid 
)
overridevirtual

Set new PID value for a joint axis.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
pidnew PID value
Returns
true/false on success/failure

Implements yarp::dev::IPidControl.

Definition at line 209 of file xHandControlBoard.cpp.

◆ setPidErrorLimit()

bool yarp::dev::xHandControlBoard::setPidErrorLimit ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j,
double  limit 
)
overridevirtual

Set the error limit for the controller on a specific joint.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
limitlimit value
Returns
true/false on success/failure

Implements yarp::dev::IPidControl.

Definition at line 270 of file xHandControlBoard.cpp.

◆ setPidErrorLimits()

bool yarp::dev::xHandControlBoard::setPidErrorLimits ( const yarp::dev::PidControlTypeEnum &  pidtype,
const double *  limits 
)
overridevirtual

Get the error limit for the controller on all joints.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
limitspointer to the vector with the new limits
Returns
true/false on success/failure

Implements yarp::dev::IPidControl.

Definition at line 275 of file xHandControlBoard.cpp.

◆ setPidOffset()

bool yarp::dev::xHandControlBoard::setPidOffset ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j,
double  v 
)
overridevirtual

Set an offset value for a given controller.

The value will added to the output of the PID controller

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
vthe offset value
Returns
true on success, false on failure.

Implements yarp::dev::IPidControl.

Definition at line 300 of file xHandControlBoard.cpp.

◆ setPidReference()

bool yarp::dev::xHandControlBoard::setPidReference ( const yarp::dev::PidControlTypeEnum &  pidtype,
int  j,
double  ref 
)
overridevirtual

Set the controller reference for a given axis.

Warning this method can result in very large torques and should be used carefully. If you do not understand this warning you should avoid using this method. Have a look at other interfaces (e.g. position control).

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
jjoint number
refnew reference point
Returns
true/false upon success/failure

Implements yarp::dev::IPidControl.

Definition at line 260 of file xHandControlBoard.cpp.

◆ setPidReferences()

bool yarp::dev::xHandControlBoard::setPidReferences ( const yarp::dev::PidControlTypeEnum &  pidtype,
const double *  refs 
)
overridevirtual

Set the controller reference, multiple axes.

Warning this method can result in very large torques and should be used carefully. If you do not understand this warning you should avoid using this method. Have a look at other interfaces (e.g. position control).

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
refspointer to the vector that contains the new reference points.
Returns
true/false upon success/failure

Implements yarp::dev::IPidControl.

Definition at line 265 of file xHandControlBoard.cpp.

◆ setPids()

bool yarp::dev::xHandControlBoard::setPids ( const yarp::dev::PidControlTypeEnum &  pidtype,
const yarp::dev::Pid *  pids 
)
overridevirtual

Set new PID value on multiple axes.

Parameters
pidtypethe id of the PID that will be affected by the command (e.g. position, velocity etc)
pidspointer to a vector of pids
Returns
true/false upon success/failure

Implements yarp::dev::IPidControl.

Definition at line 236 of file xHandControlBoard.cpp.

◆ setPosition()

bool yarp::dev::xHandControlBoard::setPosition ( int  j,
double  ref 
)
overridevirtual

Set new position for a single axis.

Parameters
jjoint number
refspecifies the new ref point
Returns
true/false on success/failure

Implements yarp::dev::IPositionDirect.

Definition at line 1085 of file xHandControlBoard.cpp.

◆ setPositions() [1/2]

bool yarp::dev::xHandControlBoard::setPositions ( const double *  refs)
overridevirtual

Set new position for a set of axis.

Parameters
refsspecifies the new reference points
Returns
true/false on success/failure

Implements yarp::dev::IPositionDirect.

Definition at line 1097 of file xHandControlBoard.cpp.

◆ setPositions() [2/2]

bool yarp::dev::xHandControlBoard::setPositions ( const int  n_joint,
const int *  joints,
const double *  refs 
)
overridevirtual

Set new reference point for all axes.

Parameters
n_jointhow many joints this command is referring to
jointslist of joints controlled. The size of this array is n_joints
refsarray, new reference points, one value for each joint, the size is n_joints. The first value will be the new reference for the joint joints[0]. for example: n_joint 3 joints 0 2 4 refs 10 30 40
Returns
true/false on success/failure

Implements yarp::dev::IPositionDirect.

Definition at line 1091 of file xHandControlBoard.cpp.

◆ setPWMLimit()

bool yarp::dev::xHandControlBoard::setPWMLimit ( int  m,
const double  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 763 of file xHandControlBoard.cpp.

◆ setRefAcceleration()

bool yarp::dev::xHandControlBoard::setRefAcceleration ( int  j,
double  acc 
)
override

Definition at line 482 of file xHandControlBoard.cpp.

◆ setRefAccelerations() [1/2]

bool yarp::dev::xHandControlBoard::setRefAccelerations ( const double *  accs)
override

Definition at line 487 of file xHandControlBoard.cpp.

◆ setRefAccelerations() [2/2]

bool yarp::dev::xHandControlBoard::setRefAccelerations ( const int  n_joints,
const int *  joints,
const double *  accs 
)
override

Definition at line 492 of file xHandControlBoard.cpp.

◆ setRefCurrent()

bool yarp::dev::xHandControlBoard::setRefCurrent ( int  m,
double  curr 
)
overridevirtual

Set the reference value of the current for a single motor.

Parameters
mmotor number
currthe current reference value for motor m. Value is expressed in amperes.
Returns
true/false on success/failure

Implements yarp::dev::ICurrentControl.

Definition at line 1230 of file xHandControlBoard.cpp.

◆ setRefCurrents() [1/2]

bool yarp::dev::xHandControlBoard::setRefCurrents ( const double *  currs)
overridevirtual

Set the reference value of the currents for all motors.

Parameters
currsthe array containing the reference current values. Values are expressed in amperes.
Returns
true/false on success/failure

Implements yarp::dev::ICurrentControl.

Definition at line 1225 of file xHandControlBoard.cpp.

◆ setRefCurrents() [2/2]

bool yarp::dev::xHandControlBoard::setRefCurrents ( const int  n_motor,
const int *  motors,
const double *  currs 
)
overridevirtual

Set the reference value of the current for a group of motors.

Parameters
n_motorsize of motors ans currs arrays
motorspointer to the array containing the list of motor numbers
currspointer to the array specifying the new current references
Returns
true/false on success/failure

Implements yarp::dev::ICurrentControl.

Definition at line 1235 of file xHandControlBoard.cpp.

◆ setRefDutyCycle()

bool yarp::dev::xHandControlBoard::setRefDutyCycle ( int  m,
double  ref 
)
overridevirtual

Sets the reference dutycycle to a single motor.

Parameters
mmotor number
refthe dutycycle, expressed as percentage (-100% +100%)
Returns
true/false on success/failure

Implements yarp::dev::IPWMControl.

Definition at line 1175 of file xHandControlBoard.cpp.

◆ setRefDutyCycles()

bool yarp::dev::xHandControlBoard::setRefDutyCycles ( const double *  refs)
overridevirtual

Sets the reference dutycycle for all the motors.

Parameters
refsthe dutycycle, expressed as percentage (-100% +100%)
Returns
true/false on success/failure

Implements yarp::dev::IPWMControl.

Definition at line 1180 of file xHandControlBoard.cpp.

◆ setRefSpeed()

bool yarp::dev::xHandControlBoard::setRefSpeed ( int  j,
double  sp 
)
override

Definition at line 467 of file xHandControlBoard.cpp.

◆ setRefSpeeds() [1/2]

bool yarp::dev::xHandControlBoard::setRefSpeeds ( const double *  spds)
override

Definition at line 472 of file xHandControlBoard.cpp.

◆ setRefSpeeds() [2/2]

bool yarp::dev::xHandControlBoard::setRefSpeeds ( const int  n_joints,
const int *  joints,
const double *  spds 
)
override

Definition at line 477 of file xHandControlBoard.cpp.

◆ setRefTorque()

bool yarp::dev::xHandControlBoard::setRefTorque ( int  j,
double  t 
)
overridevirtual

Set the reference value of the torque for a given joint.

Parameters
jjoint number
tnew value
Returns
true/false on success/failure

Implements yarp::dev::ITorqueControl.

Definition at line 964 of file xHandControlBoard.cpp.

◆ setRefTorques() [1/2]

bool yarp::dev::xHandControlBoard::setRefTorques ( const double *  t)
overridevirtual

Set the reference value of the torque for all joints.

Parameters
tpointer to the array of torque values
Returns
true/false on success/failure

Implements yarp::dev::ITorqueControl.

Definition at line 959 of file xHandControlBoard.cpp.

◆ setRefTorques() [2/2]

bool yarp::dev::xHandControlBoard::setRefTorques ( const int  n_joint,
const int *  joints,
const double *  t 
)
overridevirtual

Set new torque reference for a subset of joints.

Parameters
jointspointer to the array of joint numbers
refspointer to the array specifying the new torque reference
Returns
true/false on success/failure

Implements yarp::dev::ITorqueControl.

Definition at line 969 of file xHandControlBoard.cpp.

◆ setRemoteVariable()

bool yarp::dev::xHandControlBoard::setRemoteVariable ( std::string  key,
const yarp::os::Bottle &  val 
)
overridevirtual

Implements yarp::dev::IRemoteVariables.

Definition at line 806 of file xHandControlBoard.cpp.

◆ setTemperatureLimit()

bool yarp::dev::xHandControlBoard::setTemperatureLimit ( int  m,
const double  temp 
)
overridevirtual

Set the temperature limit for a specific motor.

The specific behavior of the motor when the temperature limit is exceeded depends on the implementation (power off recommended)

Parameters
mmotor number
tempthe temperature limit to be set
Returns
true/false

Implements yarp::dev::IMotor.

Definition at line 911 of file xHandControlBoard.cpp.

◆ setVelLimits()

bool yarp::dev::xHandControlBoard::setVelLimits ( int  axis,
double  min,
double  max 
)
overridevirtual

Set the software speed limits for a particular axis, the behavior of the control card when these limits are exceeded, depends on the implementation.

Parameters
axisjoint number
minthe value of the lower limit
maxthe value of the upper limit
Returns
true or false on success or failure

Implements yarp::dev::IControlLimits.

Definition at line 787 of file xHandControlBoard.cpp.

◆ stop() [1/3]

bool yarp::dev::xHandControlBoard::stop ( )
overridevirtual

Stop motion, multiple joints.

Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 534 of file xHandControlBoard.cpp.

◆ stop() [2/3]

bool yarp::dev::xHandControlBoard::stop ( const int  n_joint,
const int *  joints 
)
overridevirtual

Stop motion for subset of joints.

Parameters
jointspointer to the array of joint numbers
Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 539 of file xHandControlBoard.cpp.

◆ stop() [3/3]

bool yarp::dev::xHandControlBoard::stop ( int  j)
overridevirtual

Stop motion, single joint.

Parameters
jjoint number
Returns
true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 529 of file xHandControlBoard.cpp.

◆ threadInit()

bool yarp::dev::xHandControlBoard::threadInit ( )
overridevirtual

Initialization method.

The thread executes this function when it starts and before "run". This is a good place to perform initialization tasks that need to be done by the thread itself (device drivers initialization, memory allocation etc). If the function returns false the thread quits and never calls "run". The return value of threadInit() is notified to the class and passed as a parameter to afterStart(). Note that afterStart() is called by the same thread that is executing the "start" method.

Reimplemented from yarp::os::PeriodicThread.

Definition at line 1264 of file xHandControlBoard.cpp.

◆ threadRelease()

void yarp::dev::xHandControlBoard::threadRelease ( )
overridevirtual

Release method.

The thread executes this function once when it exits, after the last "run". This is a good place to release resources that were initialized in threadInit() (release memory, and device driver resources).

Reimplemented from yarp::os::PeriodicThread.

Definition at line 1268 of file xHandControlBoard.cpp.

◆ velocityMove() [1/3]

bool yarp::dev::xHandControlBoard::velocityMove ( const double *  sp)
overridevirtual

Start motion at a given speed, multiple joints.

Parameters
sppointer to the array containing the new speed values
Returns
true/false upon success/failure

Implements yarp::dev::IVelocityControl.

Definition at line 554 of file xHandControlBoard.cpp.

◆ velocityMove() [2/3]

bool yarp::dev::xHandControlBoard::velocityMove ( const int  n_joint,
const int *  joints,
const double *  spds 
)
overridevirtual

Start motion at a given speed for a subset of joints.

Parameters
n_jointhow many joints this command is referring to
jointsof joints controlled. The size of this array is n_joints
spdspointer to the array containing the new speed values, one value for each joint, the size of the array is n_joints. The first value will be the new reference for the joint joints[0]. for example: n_joint 3 joints 0 2 4 spds 10 30 40
Returns
true/false on success/failure

Implements yarp::dev::IVelocityControl.

Definition at line 1123 of file xHandControlBoard.cpp.

◆ velocityMove() [3/3]

bool yarp::dev::xHandControlBoard::velocityMove ( int  j,
double  sp 
)
overridevirtual

Start motion at a given speed, single joint.

Parameters
jjoint number
spspeed value
Returns
bool/false upon success/failure

Implements yarp::dev::IVelocityControl.

Definition at line 549 of file xHandControlBoard.cpp.


The documentation for this class was generated from the following files: