Joint Force-Torque Sensor

include/ignition/sensors/ForceTorqueSensor.hh

@@ -0,0 +1,127 @@
+/*
+ * Copyright (C) 2021 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+*/
+
+#ifndef IGNITION_SENSORS_FORCETORQUESENSOR_HH_
+#define IGNITION_SENSORS_FORCETORQUESENSOR_HH_
+
+#include <memory>
+
+#include <sdf/sdf.hh>
+
+#include <ignition/common/SuppressWarning.hh>
+#include <ignition/common/Time.hh>
+
+#include <ignition/math/Pose3.hh>
+
+#include <ignition/sensors/config.hh>
+#include <ignition/sensors/force_torque/Export.hh>
+
+#include "ignition/sensors/Sensor.hh"
+
+namespace ignition
+{
+  namespace sensors
+  {
+    // Inline bracket to help doxygen filtering.
+    inline namespace IGNITION_SENSORS_VERSION_NAMESPACE {
+    //
+    /// \brief forward declarations
+    class ForceTorqueSensorPrivate;
+
+    /// \brief Force Torque Sensor Class
+    ///
+    /// A force-torque Sensor that reports force and torque applied on a joint.
+    class IGNITION_SENSORS_FORCE_TORQUE_VISIBLE ForceTorqueSensor
+        : public Sensor
+    {
+      /// \brief constructor
+      public: ForceTorqueSensor();
+
+      /// \brief destructor
+      public: virtual ~ForceTorqueSensor();
+
+      /// \brief Load the sensor based on data from an sdf::Sensor object.
+      /// \param[in] _sdf SDF Sensor parameters.
+      /// \return true if loading was successful
+      public: virtual bool Load(const sdf::Sensor &_sdf) override;
+
+      /// \brief Load the sensor with SDF parameters.
+      /// \param[in] _sdf SDF Sensor parameters.
+      /// \return true if loading was successful
+      public: virtual bool Load(sdf::ElementPtr _sdf) override;
+
+      /// \brief Initialize values in the sensor
+      /// \return True on success
+      public: virtual bool Init() override;
+
+      /// \brief Update the sensor and generate data
+      /// \param[in] _now The current time
+      /// \return true if the update was successfull
+      public: virtual bool Update(
+        const std::chrono::steady_clock::duration &_now) override;
+
+      /// \brief Get the current joint force.
+      /// \return The latest measured force.
+      public: math::Vector3d Force() const;
+
+      /// \brief Set the force vector in sensor frame and where the force is
+      /// applied on the child (parent-to-child)
+      /// \param[in] _force force vector in newton.
+      public: void SetForce(const math::Vector3d &_force);
+
+      /// \brief Get the current joint torque.
+      /// \return The latest measured torque.
+      public: math::Vector3d Torque() const;
+
+      /// \brief Set the torque vector in sensor frame and where the torque is 
+      /// applied on the child (parent-to-child)
+      /// \param[in] _torque torque vector in newton.
+      public: void SetTorque(const math::Vector3d &_torque);
+
+      /// \brief Set the rotation of the joint parent relative to the sensor
+      /// frame.
+      /// \return The current rotation the parent in the sensor frame.
+      public: math::Quaterniond RotationParentInSensor() const;
+
+      /// \brief Set the rotation of the joint parent relative to the sensor
+      /// frame.
+      /// \param[in] _rotParentInSensorRotation of parent in sensor frame.
+      public: void SetRotationParentInSensor(
+                  const math::Quaterniond &_rotParentInSensor);
+
+      /// \brief Set the rotation of the joint parent relative to the sensor
+      /// frame.
+      /// \return The current rotation the child in the sensor frame.
+      public: math::Quaterniond RotationChildInSensor() const;
+
+      /// \brief Set the rotation of the joint child relative to the sensor
+      /// frame.
+      /// \param[in] _rotChildInSensor Rotation of child in sensor frame.
+      public: void SetRotationChildInSensor(
+                  const math::Quaterniond &_rotChildInSensor);
+
+      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
+      /// \brief Data pointer for private data
+      /// \internal
+      private: std::unique_ptr<ForceTorqueSensorPrivate> dataPtr;
+      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
+    };
+    }
+  }
+}
+
+#endif

include/ignition/sensors/SensorTypes.hh

@@ -149,6 +149,30 @@ namespace ignition
       /// \sa Lidar
       LIDAR_NOISE = 14,
 
+      /// \brief Force body-frame X axis noise in N
+      /// \sa ForceTorqueSensor
+      FORCE_X_NOISE_N = 15,
+
+      /// \brief Force body-frame Y axis noise in N
+      /// \sa ForceTorqueSensor
+      FORCE_Y_NOISE_N = 16,
+
+      /// \brief Force body-frame Z axis noise in N
+      /// \sa ForceTorqueSensor
+      FORCE_Z_NOISE_N = 17,
+
+      /// \brief Torque body-frame X axis noise in Nm
+      /// \sa ForceTorqueSensor
+      TORQUE_X_NOISE_N_M = 18,
+
+      /// \brief Torque body-frame Y axis noise in Nm
+      /// \sa ForceTorqueSensor
+      TORQUE_Y_NOISE_N_M = 19,
+
+      /// \brief Torque body-frame Z axis noise in Nm
+      /// \sa ForceTorqueSensor
+      TORQUE_Z_NOISE_N_M = 20,
+
       /// \internal
       /// \brief Indicator used to create an iterator over the enum. Do not
       /// use this.

src/CMakeLists.txt

@@ -111,6 +111,9 @@ ign_add_component(magnetometer SOURCES ${magnetometer_sources} GET_TARGET_NAME m
 set(imu_sources ImuSensor.cc)
 ign_add_component(imu SOURCES ${imu_sources} GET_TARGET_NAME imu_target)
 
+set(force_torque_sources ForceTorqueSensor.cc)
+ign_add_component(force_torque SOURCES ${force_torque_sources} GET_TARGET_NAME force_torque_target)
+
 set(altimeter_sources AltimeterSensor.cc)
 ign_add_component(altimeter SOURCES ${altimeter_sources} GET_TARGET_NAME altimeter_target)