pinocchiorobot.hh 10.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
/*
 * Copyright 2016,
 *
 * Maximilien Naveau
 * Olivier Stasse
 *
 * JRL, CNRS/AIST
 *
 * This file is part of jrl-walkgen.
 * jrl-walkgen is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * jrl-walkgen is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License
 * along with jrl-walkgen.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  Research carried out within the scope of the
 *  Joint Japanese-French Robotics Laboratory (JRL)
 */
/*! \file PinocchioRobot.hh
  \brief This object defines a humanoid robot model based on the PinocchioRobot
frame work */

#ifndef PinocchioRobot_HH
#define PinocchioRobot_HH

#include "pinocchio/spatial/se3.hpp"
Olivier Stasse's avatar
Olivier Stasse committed
33
#include "pinocchio/multibody/data.hpp"
34
#include "pinocchio/multibody/model.hpp"
35
#include "pinocchio/parsers/urdf.hpp"
Olivier Stasse's avatar
Olivier Stasse committed
36

37
38
39
namespace PatternGeneratorJRL
{
  struct PinocchioRobotFoot_t{
Olivier Stasse's avatar
Olivier Stasse committed
40
    pinocchio::JointIndex associatedAnkle ;
41
42
43
    double soleDepth ; // z axis
    double soleWidth ; // y axis
    double soleHeight ;// x axis
Olivier Stasse's avatar
Olivier Stasse committed
44
    Eigen::Vector3d anklePosition ;
45
    EIGEN_MAKE_ALIGNED_OPERATOR_NEW
46
47
48
49
50
51
  };
  typedef PinocchioRobotFoot_t PRFoot ;

  class PinocchioRobot
  {
  public:
mnaveau's avatar
mnaveau committed
52
53
    // overload the new[] eigen operator
    EIGEN_MAKE_ALIGNED_OPERATOR_NEW
54

mnaveau's avatar
mnaveau committed
55
56
    /// Constructor and Destructor
    PinocchioRobot();
57
    virtual ~PinocchioRobot();
58
59
60

    /// Functions computing kinematics and dynamics
    void computeInverseDynamics();
Olivier Stasse's avatar
Olivier Stasse committed
61
62
63
    void computeInverseDynamics(Eigen::VectorXd & q,
                                Eigen::VectorXd & v,
                                Eigen::VectorXd & a);
64
65

    void computeForwardKinematics();
Olivier Stasse's avatar
Olivier Stasse committed
66
    void computeForwardKinematics(Eigen::VectorXd & q);
67

68
69
70
71
72
73
74
    void RPYToSpatialFreeFlyer(Eigen::Vector3d & rpy,
                               Eigen::Vector3d & drpy,
                               Eigen::Vector3d & ddrpy,
                               Eigen::Quaterniond & quat,
                               Eigen::Vector3d & omega,
                               Eigen::Vector3d & domega);

75
76
    /// \brief ComputeSpecializedInverseKinematics :
    /// compute POSITION (not velocity) of the joints from end effector pose
77
78
79
80
81
82
83
84
85
86
87
    /// This is the implementation of the analitycal inverse kinematic extracted
    /// from the book of Kajita
    /// Authors Shuuji Kajita ; Hirohisa Hirukawa ; Kensuke Harada ; Kazuhito Yokoi
    /// ISBN 9782287877162 ; 9782287877155
    /// It needs a specific distribution of the joint to work.
    /// a test at the initialization of the class is [should be] done to check
    /// if everything is correct
    /// param root joint index, i.e. the waist or the shoulder
    /// param end joint index, i.e, the wrist or ankle indexes
    /// param root joint homogenous matrix position,
    /// param root joint homogenous matrix index,
88
    /// param 6D vector output, filled with zeros if the robot is not compatible
89
    ///
90
    virtual bool ComputeSpecializedInverseKinematics(
Olivier Stasse's avatar
Olivier Stasse committed
91
92
        const pinocchio::JointIndex &jointRoot,
        const pinocchio::JointIndex &jointEnd,
Olivier Stasse's avatar
Olivier Stasse committed
93
94
95
        const Eigen::Matrix4d & jointRootPosition,
        const Eigen::Matrix4d & jointEndPosition,
        Eigen::VectorXd &q);
96

97
    ///
98
99
    /// \brief testArmsInverseKinematics :
    /// test if the robot arms has the good joint
100
    /// configuration to use the analitical inverse geometry
101
    /// to be overloaded if the user wants another inverse kinematics
102
    /// RY-RX-RZ-RY-RZ-RY
103
104
    /// \return
    ///
105
106
107
108
    virtual bool testArmsInverseKinematics();
    ///
    /// \brief testLegsInverseKinematics :
    /// test if the robot legs has the good joint
109
    /// configuration to use the analitical inverse geometry
110
    /// to be overloaded if the user wants another inverse kinematics
111
112
113
    /// Two modes are available:
    /// FF-RZ-RX-RY-RY-RY-RX
    /// FF-RX-RZ-RY-RY-RY-RX
114
    /// \return
115
    ///
116
    virtual bool testLegsInverseKinematics();
117
    ///
118
119
120
121
122
    /// \brief testOneModefOfLegInverseKinematics :
    /// test if the robot legs has one good joint
    /// configuration to use the analitical inverse geometry
    /// to be overloaded if the user wants another inverse kinematics
    /// \return
123
    ///
124
125
126
    virtual bool testOneModeOfLegsInverseKinematics
    (std::vector<std::string> &leftLegJointNames,
     std::vector<std::string> &rightLegJointNames);
127
128
129
130
131
132
133

    ///
    /// \brief initializeInverseKinematics :
    /// initialize the internal data for the inverse kinematic e.g. the femur
    /// length
    /// \return
    ///
134
    virtual void initializeLegsInverseKinematics();
135

136
137
  public :
    /// tools :
Olivier Stasse's avatar
Olivier Stasse committed
138
139
140
    std::vector<pinocchio::JointIndex> jointsBetween
    ( pinocchio::JointIndex first, pinocchio::JointIndex second);
    std::vector<pinocchio::JointIndex> fromRootToIt (pinocchio::JointIndex it);
141
142

  private :
143
    // needed for the inverse geometry (ComputeSpecializedInverseKinematics)
Olivier Stasse's avatar
Olivier Stasse committed
144
145
146
    void getWaistFootKinematics(const Eigen::Matrix4d & jointRootPosition,
                                const Eigen::Matrix4d & jointEndPosition,
                                Eigen::VectorXd &q,
147
                                Eigen::Vector3d &Dt) const;
148
    double ComputeXmax(double & Z);
Olivier Stasse's avatar
Olivier Stasse committed
149
150
151
    void getShoulderWristKinematics(const Eigen::Matrix4d & jointRootPosition,
                                    const Eigen::Matrix4d & jointEndPosition,
                                    Eigen::VectorXd &q,
152
153
                                    int side);
    void DetectAutomaticallyShoulders();
Olivier Stasse's avatar
Olivier Stasse committed
154
155
    void DetectAutomaticallyOneShoulder(pinocchio::JointIndex aWrist,
                                        pinocchio::JointIndex & aShoulder);
156

157
158
159
160
161
    /*! \brief Computes the size of the free flyer/root robot
      loads by the urdf.
      Set the value of m_PinoFreeFlyerSize.
    */
    void ComputeRootSize();
162
163
164
165

  public :
    /// Getters
    /// ///////
Olivier Stasse's avatar
Olivier Stasse committed
166
    inline pinocchio::Data * Data()
167
    {return m_robotData;}
Olivier Stasse's avatar
Olivier Stasse committed
168
    inline pinocchio::Data * DataInInitialePose()
mnaveau's avatar
mnaveau committed
169
    {return m_robotDataInInitialePose;}
Olivier Stasse's avatar
Olivier Stasse committed
170
    inline pinocchio::Model * Model()
171
172
173
174
175
176
177
    {return m_robotModel;}

    inline PRFoot * leftFoot()
    {return &m_leftFoot;}
    inline PRFoot * rightFoot()
    {return &m_rightFoot;}

Olivier Stasse's avatar
Olivier Stasse committed
178
    inline pinocchio::JointIndex leftWrist()
mnaveau's avatar
mnaveau committed
179
    {return m_leftWrist;}
Olivier Stasse's avatar
Olivier Stasse committed
180
    inline pinocchio::JointIndex rightWrist()
mnaveau's avatar
mnaveau committed
181
    {return m_rightWrist;}
182

Olivier Stasse's avatar
Olivier Stasse committed
183
    inline pinocchio::JointIndex chest()
184
    {return m_chest;}
Olivier Stasse's avatar
Olivier Stasse committed
185
    inline pinocchio::JointIndex waist()
186
187
188
189
190
    {return m_waist;}

    inline double mass()
    {return m_mass;}

Olivier Stasse's avatar
Olivier Stasse committed
191
    inline pinocchio::JointModelVector & getActuatedJoints()
192
193
    {return m_robotModel->joints;}

194
    inline Eigen::VectorXd & currentConfiguration()
195
    {return m_qmal;}
196
    inline Eigen::VectorXd & currentVelocity()
197
    {return m_vmal;}
198
    inline Eigen::VectorXd & currentAcceleration()
Olivier Stasse's avatar
Olivier Stasse committed
199

200
201
202
    {return m_amal;}

    inline unsigned numberDof()
203
204
205
    {return m_robotModel->nq;}

    inline unsigned numberVelDof()
206
207
    {return m_robotModel->nv;}

Olivier Stasse's avatar
Olivier Stasse committed
208
    inline void zeroMomentumPoint(Eigen::Vector3d & zmp)
209
    {
210
      m_externalForces = m_robotData->liMi[1].act(m_robotData->f[1]);
211
212
      m_f = m_externalForces.linear() ;
      m_n = m_externalForces.angular() ;
213
214
215
216
217
      zmp(0) = -m_n(1)/m_f(2) ;
      zmp(1) =  m_n(0)/m_f(2) ;
      zmp(2) = 0.0 ; // by default
    }

Olivier Stasse's avatar
Olivier Stasse committed
218
    inline void positionCenterOfMass(Eigen::Vector3d & com)
219
220
221
222
223
224
    {
      m_com = m_robotData->com[0] ;
      com(0) = m_com(0) ;
      com(1) = m_com(1) ;
      com(2) = m_com(2) ;
    }
Olivier Stasse's avatar
Olivier Stasse committed
225
226
227
    inline void CenterOfMass(Eigen::Vector3d &   com,
                             Eigen::Vector3d &  dcom,
                             Eigen::Vector3d & ddcom)
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
    {
      m_com = m_robotData->acom[0] ;
      ddcom(0) = m_com(0) ;
      ddcom(1) = m_com(1) ;
      ddcom(2) = m_com(2) ;

      m_com = m_robotData->vcom[0] ;
      dcom(0) = m_com(0) ;
      dcom(1) = m_com(1) ;
      dcom(2) = m_com(2) ;

      m_com = m_robotData->com[0] ;
      com(0) = m_com(0) ;
      com(1) = m_com(1) ;
      com(2) = m_com(2) ;
    }
244
245
246

    /// SETTERS
    /// ///////
247
    inline void currentConfiguration(Eigen::VectorXd & conf)
248
    {m_qmal=conf;}
249
    inline void currentVelocity(Eigen::VectorXd & vel)
250
    {m_vmal=vel;}
251
    inline void currentAcceleration(Eigen::VectorXd & acc)
252
253
    {m_amal=acc;}

254
255
256
257
258
259
    inline pinocchio::JointIndex getFreeFlyerSize() const
    { return m_PinoFreeFlyerSize;}

    inline pinocchio::JointIndex getFreeFlyerVelSize() const
    { return m_PinoFreeFlyerVelSize;}

mnaveau's avatar
mnaveau committed
260
261
262
263
264
265
    /// Initialization functions
    /// ////////////////////////
    inline bool isInitialized()
    {
      return m_boolModel && m_boolData && m_boolLeftFoot && m_boolRightFoot;
    }
Olivier Stasse's avatar
Olivier Stasse committed
266
267
268
    bool checkModel(pinocchio::Model * robotModel);
    bool initializeRobotModelAndData(pinocchio::Model * robotModel,
                                     pinocchio::Data * robotData);
mnaveau's avatar
mnaveau committed
269
270
271
    bool initializeLeftFoot(PRFoot leftFoot);
    bool initializeRightFoot(PRFoot rightFoot);

272
    const std::string & getName() const;
mnaveau's avatar
mnaveau committed
273
274
    /// Attributes
    /// //////////
mnaveau's avatar
mnaveau committed
275
  private :
Olivier Stasse's avatar
Olivier Stasse committed
276
277
278
    pinocchio::Model * m_robotModel ;
    pinocchio::Data * m_robotDataInInitialePose ; // internal variable
    pinocchio::Data * m_robotData ;
mnaveau's avatar
mnaveau committed
279
280
    PRFoot m_leftFoot , m_rightFoot ;
    double m_mass ;
Olivier Stasse's avatar
Olivier Stasse committed
281
282
    pinocchio::JointIndex m_chest, m_waist, m_leftShoulder, m_rightShoulder ;
    pinocchio::JointIndex m_leftWrist , m_rightWrist ;
mnaveau's avatar
mnaveau committed
283

Olivier Stasse's avatar
Olivier Stasse committed
284
285
286
    Eigen::VectorXd m_qmal ;
    Eigen::VectorXd m_vmal ;
    Eigen::VectorXd m_amal ;
mnaveau's avatar
mnaveau committed
287
288
289

    // tmp variables
    Eigen::Quaterniond m_quat ;
290
    Eigen::Matrix3d m_rot ;
Olivier Stasse's avatar
Olivier Stasse committed
291
    pinocchio::Force m_externalForces ; // external forces and torques
292
    Eigen::VectorXd m_tau ; // external forces and torques
mnaveau's avatar
mnaveau committed
293
294
    Eigen::Vector3d m_f,m_n; // external forces and torques
    Eigen::Vector3d m_com; // multibody CoM
295
296
    Eigen::Matrix3d m_S ;
    Eigen::Vector3d m_rpy,m_drpy,m_ddrpy,m_omega,m_domega ;
mnaveau's avatar
mnaveau committed
297

298
299
    // Variables extracted form the urdf used for the analitycal inverse
    // kinematic
300
    bool m_isLegInverseKinematic ;
301
    unsigned int m_modeLegInverseKinematic;
302
303
    bool m_isArmInverseKinematic ;

304
    // length between the waist and the hip
Olivier Stasse's avatar
Olivier Stasse committed
305
    Eigen::Vector3d m_leftDt, m_rightDt ;
306
    double m_femurLength ;
307
308
    double m_tibiaLengthZ ;
    double m_tibiaLengthY ;
309
310


mnaveau's avatar
mnaveau committed
311
312
313
314
    bool m_boolModel     ;
    bool m_boolData      ;
    bool m_boolLeftFoot  ;
    bool m_boolRightFoot ;
mnaveau's avatar
mnaveau committed
315

316
317
318
319
320
321
    /// \brief Size of the free flyer configuration space.
    pinocchio::JointIndex m_PinoFreeFlyerSize;

    /// \brief Size of the free flyer velocity space.
    pinocchio::JointIndex m_PinoFreeFlyerVelSize;

mnaveau's avatar
mnaveau committed
322
323
  }; //PinocchioRobot
}// namespace PatternGeneratorJRL
324
#endif // PinocchioRobot_HH