gazebo_ros_kobuki.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013, Yujin Robot.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Yujin Robot nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef GAZEBO_ROS_KOBUKI_H
#define GAZEBO_ROS_KOBUKI_H

#include <cmath>
#include <cstring>
#include <string>
#include <boost/bind.hpp>
#include <boost/thread.hpp>
#include <boost/shared_ptr.hpp>
#include <gazebo/gazebo.hh>
#include <gazebo/common/common.hh>
#include <gazebo/common/Time.hh>
#if GAZEBO_MAJOR_VERSION >= 9
  // #include <ignition/math.hh>
  #include <ignition/math/Vector3.hh>
  #include <ignition/math/Quaternion.hh>
#else
  #include <gazebo/math/gzmath.hh>
#endif
#include <gazebo/physics/physics.hh>
#include <gazebo/sensors/sensors.hh>
#include <gazebo_plugins/gazebo_ros_utils.h>
#include <ros/ros.h>
#include <std_msgs/Empty.h>
#include <std_msgs/Float64.h>
#include <sensor_msgs/Imu.h>
#include <sensor_msgs/JointState.h>
#include <nav_msgs/Odometry.h>
#include <geometry_msgs/Twist.h>
#include <geometry_msgs/TransformStamped.h>
#include <tf/transform_broadcaster.h>
#include <tf/LinearMath/Quaternion.h>
#include <kobuki_msgs/MotorPower.h>
#include <kobuki_msgs/CliffEvent.h>
#include <kobuki_msgs/BumperEvent.h>

namespace gazebo
{

enum {LEFT= 0, RIGHT=1};

class GazeboRosKobuki : public ModelPlugin
{
public:
  GazeboRosKobuki();
  ~GazeboRosKobuki();
  void Load(physics::ModelPtr parent, sdf::ElementPtr sdf);
  void OnUpdate();

private:
  /*
   * Methods
   */
  void cmdVelCB(const geometry_msgs::TwistConstPtr &msg);
  void motorPowerCB(const kobuki_msgs::MotorPowerPtr &msg);
  void resetOdomCB(const std_msgs::EmptyConstPtr &msg);
  void spin();
  //  void OnContact(const std::string &name, const physics::Contact &contact); necessary?


  // internal functions for load
  void prepareMotorPower();
  bool prepareJointState();
  void preparePublishTf();
  bool prepareWheelAndTorque();
  void prepareOdom();
  bool prepareVelocityCommand();
  bool prepareCliffSensor();
  bool prepareBumper();
  bool prepareIMU();
  void setupRosApi(std::string& model_name);

  // internal functions for update
  void updateJointState();
  void updateOdometry(common::Time& step_time);
  void updateIMU();
  void propagateVelocityCommands();
  void updateCliffSensor();
  void updateBumper();


  /*
   *  Parameters
   */
  ros::NodeHandle nh_, nh_priv_;
  std::string node_name_;

  std::string tf_prefix_;
//  boost::shared_ptr<boost::thread> ros_spinner_thread_; necessary?
  bool shutdown_requested_;
  physics::ModelPtr model_;
  GazeboRosPtr gazebo_ros_;
  sdf::ElementPtr sdf_;
  physics::WorldPtr world_;
  event::ConnectionPtr update_connection_;
  common::Time prev_update_time_;
  ros::Subscriber motor_power_sub_;
  bool motors_enabled_;
  physics::JointPtr joints_[2];
  std::string left_wheel_joint_name_;
  std::string right_wheel_joint_name_;
  ros::Publisher joint_state_pub_;
  sensor_msgs::JointState joint_state_;
  ros::Subscriber cmd_vel_sub_;
  common::Time last_cmd_vel_time_;
  double cmd_vel_timeout_;
  double wheel_speed_cmd_[2];
  double torque_;
  double wheel_sep_;
  double wheel_diam_;
  double odom_pose_[3];
  double odom_vel_[3];
  double *pose_cov_[36];
  double *twist_cov_[36];
  ros::Publisher odom_pub_;
  nav_msgs::Odometry odom_;
  bool publish_tf_;
  tf::TransformBroadcaster tf_broadcaster_;
  geometry_msgs::TransformStamped odom_tf_;
  sensors::RaySensorPtr cliff_sensor_left_;
  sensors::RaySensorPtr cliff_sensor_center_;
  sensors::RaySensorPtr cliff_sensor_right_;
  ros::Publisher cliff_event_pub_;
  kobuki_msgs::CliffEvent cliff_event_;
  bool cliff_detected_left_;
  bool cliff_detected_center_;
  bool cliff_detected_right_;
  float cliff_detection_threshold_;
  int floot_dist_;
  sensors::ContactSensorPtr bumper_;
  ros::Publisher bumper_event_pub_;
  kobuki_msgs::BumperEvent bumper_event_;
  bool bumper_left_was_pressed_;
  bool bumper_center_was_pressed_;
  bool bumper_right_was_pressed_;
  bool bumper_left_is_pressed_;
  bool bumper_center_is_pressed_;
  bool bumper_right_is_pressed_;
  sensors::ImuSensorPtr imu_;

  #if GAZEBO_MAJOR_VERSION >= 9
    ignition::math::Vector3d vel_angular_;
  #else
    math::Vector3 vel_angular_;
  #endif

  ros::Publisher imu_pub_;
  sensor_msgs::Imu imu_msg_;
  ros::Subscriber odom_reset_sub_;



};

} // namespace gazebo

#endif /* GAZEBO_ROS_KOBUKI_H */