TaskspaceVelocityController.cpp

Go to the documentation of this file.

#include "TaskspaceVelocityController.h"
 
#include <SimoxUtility/math/convert/mat4f_to_quat.h>
#include <VirtualRobot/IK/DifferentialIK.h>
#include <VirtualRobot/IK/JacobiProvider.h>
#include <VirtualRobot/MathTools.h>
#include <VirtualRobot/Nodes/RobotNode.h>
#include <VirtualRobot/Robot.h>
#include <VirtualRobot/RobotNodeSet.h>
 
#include <RobotAPI/components/units/RobotUnit/util/ControlThreadOutputBuffer.h>
 
#include <armarx/control/common/device.h>
 
#include "../utils.h"
 
namespace armarx::control::common::control_law
{
 
    void
    TaskspaceVelocityController::initialize(const VirtualRobot::RobotNodeSetPtr& rns,
                                            const VirtualRobot::RobotNodeSetPtr& rtRns)
    {
        ARMARX_CHECK_NOT_NULL(rns);
        numOfJoints = rns->getSize();
 
        tcp = rns->getTCP();
        rtTCP = rtRns->getTCP();
        ARMARX_CHECK_NOT_NULL(tcp);
        ik.reset(new VirtualRobot::DifferentialIK(
            rtRns, rtRns->getRobot()->getRootNode(), VirtualRobot::JacobiProvider::eSVDDamped));
 
        I = Eigen::MatrixXf::Identity(numOfJoints, numOfJoints);
    }
 
    void
    TaskspaceVelocityController::preactivateInit(const VirtualRobot::RobotNodeSetPtr& rns)
    {
    }
 
    void
    TaskspaceVelocityController::firstRun()
    {
        ftsensor.reset();
    }
 
    // bool
    // TaskspaceVelocityController::isControlModeValid(
    //     const std::vector<std::string>& nameList,
    //     const std::map<std::string, std::string>& jointControlModeMap)
    // {
    //     std::set<std::string> validModes = {"velocity", "torque"};
    //
    //     for (const auto& pair : jointControlModeMap)
    //     {
    //         if (std::find(nameList.begin(), nameList.end(), pair.first) == nameList.end())
    //         {
    //             ARMARX_ERROR << "TaskspaceVelocityController: joint name '"
    //                          << pair.first << "' not found in robot node set.";
    //             return false;
    //         }
    //
    //         if (validModes.find(pair.second) == validModes.end())
    //         {
    //             ARMARX_ERROR
    //                 << "TaskspaceVelocityController: Invalid control mode for joint '"
    //                 << pair.first << "': " << pair.second << std::endl;
    //             return false;
    //         }
    //     }
    //
    //     return true;
    // }
 
    // void
    // TaskspaceVelocityController::updateFT(const FTConfig& c, RtStatus& rtStatus)
    // {
    //     /// run in rt thread
    //     ftsensor.updateStatus();
    //     if (c.reCalibrate)
    //     {
    //         ftsensor.calibrated.store(false);
    //         /// TODO how to toggle recalibration?
    //     }
    //     ftsensor.compensateTCPGravity(c);
    //     if (!ftsensor.calibrated.load())
    //     {
    //         if (ftsensor.calibrate(c, rtStatus.deltaT))
    //         {
    //             ftsensor.calibrated.store(true);
    //         }
    //     }
    //     else
    //     {
    //         rtStatus.currentForceTorque = ftsensor.getFilteredForceTorque(c);
    //     }
    // }
 
    void
    TaskspaceVelocityController::run(Config& c, RtStatus& rtStatus)
    {
        /// run in rt thread
        rtStatus.currentPose = rtTCP->getPoseInRootFrame();
 
        /// ---------------------------- safety guard by FT and target pose ------------------------
        rtStatus.poseDiffMatImp =
            c.desiredPose.block<3, 3>(0, 0) * rtStatus.currentPose.block<3, 3>(0, 0).transpose();
        rtStatus.oriDiffAngleAxis.fromRotationMatrix(rtStatus.poseDiffMatImp);
 
        /// this should not be moved to non rt, just in case non rt thread dies, rt still functions as safely
        if (not ftsensor.isSafe(c.ftConfig))
        {
            ARMARX_INFO << "FTGuard indicates RT not safe";
            c.desiredPose = rtStatus.desiredPose;
            rtStatus.rtSafe = false;
            rtStatus.rtTargetSafe = true;
        }
        else if ((c.desiredPose.block<3, 1>(0, 3) - rtStatus.currentPose.block<3, 1>(0, 3)).norm() >
                     c.safeDistanceMMToGoal or
                 std::fminf(rtStatus.oriDiffAngleAxis.angle(),
                            2 * M_PI - rtStatus.oriDiffAngleAxis.angle()) >
                     VirtualRobot::MathTools::deg2rad(c.safeRotAngleDegreeToGoal))
        {
            c.desiredPose = rtStatus.desiredPose;
            rtStatus.rtSafe = false;
            rtStatus.rtTargetSafe = false;
        }
        else
        {
            rtStatus.desiredPose = c.desiredPose;
            rtStatus.rtSafe = true;
            rtStatus.rtTargetSafe = true;
        }
 
        /// ------------------------------ compute jacobi ------------------------------------------
        rtStatus.jacobi =
            ik->getJacobianMatrix(rtTCP, VirtualRobot::IKSolver::CartesianSelection::All);
        ARMARX_CHECK_EQUAL(rtStatus.numJoints, rtStatus.jacobi.cols());
        ARMARX_CHECK_EQUAL(6, rtStatus.jacobi.rows());
 
        // rtStatus.jpinv = ik->computePseudoInverseJacobianMatrix(rtStatus.jacobi, lambda);
        rtStatus.jpinv = ik->computePseudoInverseJacobianMatrix(
            rtStatus.jacobi,
            ik->getJacobiRegularization(VirtualRobot::IKSolver::CartesianSelection::All));
        ARMARX_CHECK_EQUAL(6, rtStatus.jpinv.cols());
        ARMARX_CHECK_EQUAL(rtStatus.numJoints, rtStatus.jpinv.rows());
 
        // rtStatus.jacobi.block(0, 0, 3, rtStatus.numJoints) =
        //     0.001 * rtStatus.jacobi.block(0, 0, 3, rtStatus.numJoints);
        // rtStatus.jpinv.block(0, 0, rtStatus.numJoints, 3) =
        //         0.001 * rtStatus.jpinv.block(0, 0, rtStatus.numJoints, 3);
 
        /// ------------------------------ update velocity/twist -----------------------------------
        ARMARX_CHECK_EQUAL(rtStatus.numJoints, rtStatus.jointPos.rows());
        ARMARX_CHECK_EQUAL(rtStatus.numJoints, rtStatus.jointVel.rows());
        ARMARX_CHECK_EQUAL(rtStatus.numJoints, rtStatus.qvelFiltered.rows());
 
        rtStatus.qvelFiltered =
            (1 - c.qvelFilter) * rtStatus.qvelFiltered + c.qvelFilter * rtStatus.jointVel;
        rtStatus.currentTwist = rtStatus.jacobi * rtStatus.qvelFiltered; /// in mm/s
 
        /// ------------------------------------- TS Error --------------------------------
        /// calculate pose error between target pose and current pose
        /// !!! This is very important: you have to keep position and orientation both
        ///     with UI unit (meter, radian) to calculate impedance force.
 
        rtStatus.poseDiffMatImp = rtStatus.desiredPose.block<3, 3>(0, 0) *
                                  rtStatus.currentPose.block<3, 3>(0, 0).transpose();
        // rtStatus.poseErrorImp.head<3>() = 0.001 * (rtStatus.desiredPose.block<3, 1>(0, 3) -
        //                                          rtStatus.currentPose.block<3, 1>(0, 3));
        rtStatus.poseErrorImp.head<3>() = (rtStatus.desiredPose.block<3, 1>(0, 3) -
                                         rtStatus.currentPose.block<3, 1>(0, 3)); /// in mm
        rtStatus.poseErrorImp.tail<3>() =
            VirtualRobot::MathTools::eigen3f2rpy(rtStatus.poseDiffMatImp);
 
        /// ------------------------------------- Velocity control ---------------------------------------------------
        /// calculate pose error between target pose and current pose
        /// !!! This is very important: you have to keep position and orientation both
        ///     with UI unit (meter, radian) to calculate desired Cartesian velocity.
        rtStatus.cartesianVelTarget = c.kpCartesianVel.cwiseProduct(rtStatus.poseErrorImp) -
                                      c.kdCartesianVel.cwiseProduct(rtStatus.currentTwist);
 
        /// ----------------------------- Nullspace PD Control --------------------------------------------------
        ARMARX_CHECK_EQUAL(rtStatus.numJoints, c.kpNullspaceVel.rows());
        ARMARX_CHECK_EQUAL(rtStatus.numJoints, c.kdNullspaceVel.rows());
        ARMARX_CHECK_EQUAL(rtStatus.numJoints, rtStatus.nullspaceVelocity.rows());
        ARMARX_CHECK_EQUAL(rtStatus.numJoints, c.desiredNullspaceJointAngles.value().size());
 
        rtStatus.nullspaceVelocity =
            c.kpNullspaceVel.cwiseProduct(c.desiredNullspaceJointAngles.value() -
                                          rtStatus.jointPos) -
            c.kdNullspaceVel.cwiseProduct(rtStatus.qvelFiltered);
 
        /// ----------------------------- Map TS target force/velocity to JS --------------------------------------------------
        ARMARX_CHECK_EQUAL(rtStatus.numJoints, rtStatus.desiredJointVelocity.rows());
        rtStatus.desiredJointVelocity =
            rtStatus.jpinv * rtStatus.cartesianVelTarget +
            (I - rtStatus.jpinv * rtStatus.jacobi) * rtStatus.nullspaceVelocity;
 
        /// ----------------------------- write torque target  -------------------------------------
        for (int i = 0; i < rtStatus.desiredJointVelocity.rows(); ++i)
        {
            rtStatus.desiredJointVelocity(i) =
                std::clamp(rtStatus.desiredJointVelocity(i), -c.velocityLimit, c.velocityLimit);
        }
    }
 
    void
    TaskspaceVelocityController::RtStatus::reset(const unsigned int nDoF)
    {
        /// This function can be called before the RT thread.
        /// base
        jointPosition.resize(nDoF, 0.);
        jointVelocity.resize(nDoF, 0.);
        jointTorque.resize(nDoF, 0.);
        jointPos.setZero(nDoF);
        jointVel.setZero(nDoF);
        jointTor.setZero(nDoF);
        deltaT = 0.0;
        accumulateTime = 0.0;
        numJoints = nDoF;
        // nDoFTorque = numDoFTorque;
        // nDoFVelocity = numDoFVelocity;
        // ARMARX_CHECK_EQUAL(numJoints, nDoFTorque + nDoFVelocity);
 
        /// targets
        desiredJointVelocity.setZero(nDoF);
        cartesianVelTarget.setZero();
        nullspaceVelocity.setZero(nDoF);
 
        /// force torque
        currentForceTorque.setZero();
 
        /// current status
        qvelFiltered.setZero(nDoF);
        currentPose.setZero();
        currentTwist.setZero();
        desiredPose.setZero();
 
        /// intermediate results
        poseDiffMatImp.setZero();
        poseErrorImp.setZero();
        oriDiffAngleAxis = Eigen::AngleAxisf::Identity();
 
        /// others
        jacobi.setZero(6, nDoF);
        jpinv.setZero(nDoF, 6);
        rtSafe = false;
        rtTargetSafe = true;
    }
 
    void
    TaskspaceVelocityController::RtStatus::rtPreActivate(const Eigen::Matrix4f& currentTCPPose)
    {
        /// !!!! TO BE UPDATED IN PREACTIVATE !!!!
        /// only then the up-to-date robot joint information is available
        currentPose = currentTCPPose;
        desiredPose = currentTCPPose;
        accumulateTime = 0.0;
    }
 
} // namespace armarx::control::common::control_law