AdmittanceController.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * ArmarX is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  *
8  * ArmarX is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * @package ...
17  * @author Jianfeng Gao ( jianfeng dot gao at kit dot edu )
18  * @date 2021
19  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
20  * GNU General Public License
21  */
22 
23 #pragma once
24 
25 #include <VirtualRobot/Robot.h>
26 
31 
33 #include <armarx/control/interface/ConfigurableNJointControllerInterface.h>
34 #include <armarx/control/njoint_controller/task_space/ControllerInterface.h>
36 
37 
39 {
41  /**
42  * @defgroup Library-NJointTaskspaceAdmittanceController NJointTaskspaceAdmittanceController
43  * @ingroup Library-RobotUnit-NJointControllers
44  * A description of the library NJointTaskspaceAdmittanceController.
45  *
46  * @class NJointTaskspaceAdmittanceController
47  * @ingroup Library-NJointTaskspaceAdmittanceController
48  * @brief Brief description of class NJointTaskspaceAdmittanceController.
49  *
50  * Detailed description of class NJointTaskspaceAdmittanceController.
51  */
53  virtual public NJointController,
55  {
56  public:
57  using ConfigPtrT = ConfigurableNJointControllerConfigPtr;
58  using AronDTO = law::arondto::TaskspaceAdmittanceControllerConfig;
59  using BO = law::TaskspaceAdmittanceController::Config;
60 
62  const NJointControllerConfigPtr& config,
63  const VirtualRobot::RobotPtr&);
64 
65  std::string getClassName(const Ice::Current&) const override;
66 
67  void rtRun(const IceUtil::Time& sensorValuesTimestamp,
68  const IceUtil::Time& timeSinceLastIteration) override;
69 
70  /// NJointController interface
71  // std::string getKinematicChainName(const Ice::Current&) override;
72 
74  const Ice::Current& iceCurrent = Ice::emptyCurrent) override;
75 
76  void validateConfigData(BO& config);
77 
78  /// ft sensor
79  void toggleGravityCompensation(const bool toggle, const Ice::Current &) override;
80  void calibrateFTSensor(const Ice::Current&) override;
81 
82  protected:
83  virtual void additionalTask();
84  void onPublish(const SensorAndControl&,
86  const DebugObserverInterfacePrx&) override;
87 
88  protected:
89  /// devices
91  {
92  std::vector<const SensorValue1DoFActuatorTorque*> torqueSensors;
93  std::vector<const SensorValue1DoFActuatorVelocity*> velocitySensors;
94  std::vector<const SensorValue1DoFActuatorPosition*> positionSensors;
95  };
97 
98  std::vector<ControlTarget1DoFActuatorTorque*> targets;
99 
100  protected:
101  /// variables
102  std::string kinematicChainName;
103  std::vector<std::string> jointNames;
105 
106  /// set buffers
110 
111  std::atomic_bool rtFirstRun = true;
112  std::atomic_bool rtReady = false;
113  std::atomic_bool reInitPreActivate = false;
114 
116 
118 
119  RobotUnitPtr robotUnit;
120 
121  protected:
122  /// NJointControllerBase interface
123  void onInitNJointController() override;
124  void rtPreActivateController() override;
125  void rtPostDeactivateController() override;
126  };
127 } /// namespace armarx::control::njoint_controller::task_space
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::controlTargets
common::control_law::ControlTarget controlTargets
Definition: AdmittanceController.h:117
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::reInitPreActivate
std::atomic_bool reInitPreActivate
Definition: AdmittanceController.h:113
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::bufferRtToAdditionalTask
TripleBuffer< law::RobotStatus > bufferRtToAdditionalTask
Definition: AdmittanceController.h:109
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::toggleGravityCompensation
void toggleGravityCompensation(const bool toggle, const Ice::Current &) override
ft sensor
Definition: AdmittanceController.cpp:267
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::robotUnit
RobotUnitPtr robotUnit
Definition: AdmittanceController.h:119
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::bufferUserToRt
TripleBuffer< BO > bufferUserToRt
Definition: AdmittanceController.h:108
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::SensorDevices::velocitySensors
std::vector< const SensorValue1DoFActuatorVelocity * > velocitySensors
Definition: AdmittanceController.h:93
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::rtPostDeactivateController
void rtPostDeactivateController() override
This function is called after the controller is deactivated.
Definition: AdmittanceController.cpp:311
armarx::control::common::control_law::TaskspaceAdmittanceController
Definition: TaskspaceAdmittanceController.h:39
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::SensorDevices::torqueSensors
std::vector< const SensorValue1DoFActuatorTorque * > torqueSensors
Definition: AdmittanceController.h:92
RobotUnit.h
armarx::SynchronousNJointController
Definition: NJointControllerBase.h:1145
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::onPublish
void onPublish(const SensorAndControl &, const DebugDrawerInterfacePrx &, const DebugObserverInterfacePrx &) override
Definition: AdmittanceController.cpp:235
armarx::control::njoint_controller::task_space
Definition: AdmittanceController.cpp:35
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::nonRtRobot
VirtualRobot::RobotPtr nonRtRobot
Definition: AdmittanceController.h:115
armarx::NJointControllerBase::ConfigPtrT
NJointControllerConfigPtr ConfigPtrT
Definition: NJointControllerBase.h:586
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::rtPreActivateController
void rtPreActivateController() override
This function is called before the controller is activated.
Definition: AdmittanceController.cpp:276
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::rtRun
void rtRun(const IceUtil::Time &sensorValuesTimestamp, const IceUtil::Time &timeSinceLastIteration) override
TODO make protected and use attorneys.
Definition: AdmittanceController.cpp:155
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::targets
std::vector< ControlTarget1DoFActuatorTorque * > targets
Definition: AdmittanceController.h:98
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::SensorDevices
devices
Definition: AdmittanceController.h:90
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::rtReady
std::atomic_bool rtReady
Definition: AdmittanceController.h:112
armarx::detail::ControlThreadOutputBufferEntry
Definition: ControlThreadOutputBuffer.h:177
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::additionalTask
virtual void additionalTask()
Definition: AdmittanceController.cpp:145
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::AronDTO
law::arondto::TaskspaceAdmittanceControllerConfig AronDTO
Definition: AdmittanceController.h:58
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::getClassName
std::string getClassName(const Ice::Current &) const override
Definition: AdmittanceController.cpp:113
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::BO
law::TaskspaceAdmittanceController::Config BO
Definition: AdmittanceController.h:59
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController
Brief description of class NJointTaskspaceAdmittanceController.
Definition: AdmittanceController.h:52
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::bufferUserToAdditionalTask
TripleBuffer< BO > bufferUserToAdditionalTask
set buffers
Definition: AdmittanceController.h:107
armarx::control::common::control_law
namespace armarx::control::common::ft
Definition: aron_conversions.cpp:62
ControlTarget1DoFActuator.h
TaskspaceAdmittanceController.h
armarx::control::NJointTaskspaceAdmittanceControllerInterface
Definition: ControllerInterface.ice:41
armarx::armem::Time
armarx::core::time::DateTime Time
Definition: forward_declarations.h:13
NJointController.h
armarx::aron::data::DictPtr
std::shared_ptr< Dict > DictPtr
Definition: Dict.h:41
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::validateConfigData
void validateConfigData(BO &config)
Definition: AdmittanceController.cpp:211
IceInternal::ProxyHandle<::IceProxy::armarx::DebugDrawerInterface >
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::sensorDevices
SensorDevices sensorDevices
Definition: AdmittanceController.h:96
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::updateConfig
void updateConfig(const ::armarx::aron::data::dto::DictPtr &dto, const Ice::Current &iceCurrent=Ice::emptyCurrent) override
NJointController interface.
Definition: AdmittanceController.cpp:196
armarx::control::NJointTaskspaceAdmittanceControllerInterface::calibrateFTSensor
void calibrateFTSensor()
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::kinematicChainName
std::string kinematicChainName
variables
Definition: AdmittanceController.h:102
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::controller
law::TaskspaceAdmittanceController controller
Definition: AdmittanceController.h:104
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::rtFirstRun
std::atomic_bool rtFirstRun
Definition: AdmittanceController.h:111
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::SensorDevices::positionSensors
std::vector< const SensorValue1DoFActuatorPosition * > positionSensors
Definition: AdmittanceController.h:94
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::onInitNJointController
void onInitNJointController() override
NJointControllerBase interface.
Definition: AdmittanceController.cpp:124
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::jointNames
std::vector< std::string > jointNames
Definition: AdmittanceController.h:103
armarx::control::common::control_law::ControlTarget
Definition: common.h:44
armarx::control::njoint_controller::task_space::NJointTaskspaceAdmittanceController::NJointTaskspaceAdmittanceController
NJointTaskspaceAdmittanceController(const RobotUnitPtr &robotUnit, const NJointControllerConfigPtr &config, const VirtualRobot::RobotPtr &)
Definition: AdmittanceController.cpp:41
SensorValue1DoFActuator.h
VirtualRobot::RobotPtr
std::shared_ptr< class Robot > RobotPtr
Definition: Bus.h:18
armarx::TripleBuffer< BO >
controller_descriptions.h