Statistics
| Branch: | Revision:

root / scout / scoutsim / src / scout.h @ eb9cff77

History | View | Annotate | Download (7.45 KB)

1 c492be62 Alex Zirbel
/**
2
 * The code in this package was developed using the structure of Willow
3
 * Garage's turtlesim package.  It was modified by the CMU Robotics Club
4
 * to be used as a simulator for the Colony Scout robot.
5 266ae7f2 Alex Zirbel
 *
6 c492be62 Alex Zirbel
 * All redistribution of this code is limited to the terms of Willow Garage's
7
 * licensing terms, as well as under permission from the CMU Robotics Club.
8
 * 
9
 * Copyright (c) 2011 Colony Project
10
 * 
11
 * Permission is hereby granted, free of charge, to any person
12
 * obtaining a copy of this software and associated documentation
13
 * files (the "Software"), to deal in the Software without
14
 * restriction, including without limitation the rights to use,
15
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
16
 * copies of the Software, and to permit persons to whom the
17
 * Software is furnished to do so, subject to the following
18
 * conditions:
19
 * 
20
 * The above copyright notice and this permission notice shall be
21
 * included in all copies or substantial portions of the Software.
22
 * 
23
 * Copyright (c) 2009, Willow Garage, Inc.
24 266ae7f2 Alex Zirbel
 * All rights reserved.
25 c492be62 Alex Zirbel
 * 
26
 * Redistribution and use in source and binary forms, with or without
27
 * modification, are permitted provided that the following conditions are met:
28
 * 
29
 *    Redistributions of source code must retain the above copyright
30
 *       notice, this list of conditions and the following disclaimer.
31
 *    Redistributions in binary form must reproduce the above copyright
32
 *       notice, this list of conditions and the following disclaimer in the
33
 *       documentation and/or other materials provided with the distribution.
34
 *    Neither the name of the Willow Garage, Inc. nor the names of its
35
 *       contributors may be used to endorse or promote products derived from
36
 *       this software without specific prior written permission.
37
 * 
38
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
39
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
40
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
41
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
42
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
43
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
44
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
45
 * OTHER DEALINGS IN THE SOFTWARE.
46 266ae7f2 Alex Zirbel
 */
47
48 144137a1 Alex Zirbel
#ifndef _SCOUTSIM_SCOUT_H_
49
#define _SCOUTSIM_SCOUT_H_
50 266ae7f2 Alex Zirbel
51
#include <ros/ros.h>
52 af0d9743 Alex
#include <vector>
53 266ae7f2 Alex Zirbel
#include <boost/shared_ptr.hpp>
54
55 a8480867 Alex Zirbel
#include <motors/set_motors.h>
56 9f547ef7 Alex Zirbel
#include <encoders/query_encoders.h>
57 af0d9743 Alex
#include <linesensor/query_linesensor.h>
58 a2e6bd4c Alex
#include <sonar/sonar_distance.h>
59 eb9cff77 Hui Jun Tay
#include <sonar/sonar_toggle.h>
60
#include <sonar/sonar_set_scan.h>
61 a8480867 Alex Zirbel
62 266ae7f2 Alex Zirbel
#include <scoutsim/Pose.h>
63
#include <scoutsim/SetPen.h>
64
#include <scoutsim/Color.h>
65
66 e3f69e61 Alex
#include <geometry_msgs/Pose2D.h>
67
68 266ae7f2 Alex Zirbel
#include <wx/wx.h>
69
70 e3f69e61 Alex
#include "scoutsim_internal.h"
71 a2e6bd4c Alex
#include "scout_constants.h"
72 c492be62 Alex Zirbel
73 266ae7f2 Alex Zirbel
#define PI 3.14159265
74 c492be62 Alex Zirbel
75 144137a1 Alex Zirbel
/// The scale factor so the speed of scout robots is reasonable for the sim
76
#define SPEED_SCALE_FACTOR 0.05
77 266ae7f2 Alex Zirbel
78 ade1b7f9 Alex
#define NUM_LINESENSORS 8
79
80
// Distance, pixels, from center of robot to the linesensors.
81
#define LNSNSR_D 20
82
83 266ae7f2 Alex Zirbel
namespace scoutsim
84
{
85
    struct Vector2
86
    {
87
        Vector2()
88
            : x(0.0)
89
              , y(0.0)
90
        {}
91
92 144137a1 Alex Zirbel
        Vector2(float new_x, float new_y)
93
            : x(new_x)
94
              , y(new_y)
95 266ae7f2 Alex Zirbel
        {}
96
97
        bool operator==(const Vector2& rhs)
98
        {
99
            return x == rhs.x && y == rhs.y;
100
        }
101
102
        bool operator!=(const Vector2& rhs)
103
        {
104
            return x != rhs.x || y != rhs.y;
105
        }
106
107
        float x;
108
        float y;
109
    };
110
111
    class Scout
112
    {
113
        public:
114 6639ce9c viki
            Scout(const ros::NodeHandle& nh,const wxImage& scout_image,
115
                  const Vector2& pos, wxBitmap *path_bitmap, float orient);
116 266ae7f2 Alex Zirbel
117 9b3564f3 Alex Zirbel
            geometry_msgs::Pose2D update(double dt, wxMemoryDC& path_dc,
118 68b23184 viki
                                         wxMemoryDC& sonar_dc,
119 eb9cff77 Hui Jun Tay
                     bool sonar_visual,
120 9b3564f3 Alex Zirbel
                                         const wxImage& path_image,
121 ade1b7f9 Alex
                                         const wxImage& lines_image,
122 a2e6bd4c Alex
                                         const wxImage& walls_image,
123 9b3564f3 Alex Zirbel
                                         wxColour background_color,
124 6639ce9c viki
                                          wxColour sonar_color,
125 9b3564f3 Alex Zirbel
                                         world_state state);
126 266ae7f2 Alex Zirbel
            void paint(wxDC& dc);
127
128
        private:
129 a8480867 Alex Zirbel
            void setMotors(const motors::set_motors::ConstPtr& msg);
130 266ae7f2 Alex Zirbel
            bool setPenCallback(scoutsim::SetPen::Request&,
131
                                scoutsim::SetPen::Response&);
132 9f547ef7 Alex Zirbel
            bool query_encoders_callback(encoders::query_encoders::Request&,
133
                                         encoders::query_encoders::Response&);
134 af0d9743 Alex
            bool query_linesensor_callback(linesensor::query_linesensor::Request&,
135
                                           linesensor::query_linesensor::Response&);
136 eb9cff77 Hui Jun Tay
            bool handle_sonar_toggle(sonar::sonar_toggle::Request  &req,
137
                                     sonar::sonar_toggle::Response &res);
138
            bool handle_sonar_set_scan(sonar::sonar_set_scan::Request  &req,
139
                                       sonar::sonar_set_scan::Response &res);
140 a2e6bd4c Alex
            unsigned int rgb_to_grey(unsigned char r,
141
                                     unsigned char g,
142
                                     unsigned char b);
143
            unsigned int trace_sonar(const wxImage& walls_image, int x, int y,
144 eb9cff77 Hui Jun Tay
                                     double robot_theta, int sonar_pos,wxMemoryDC& sonar_dc);
145 a2e6bd4c Alex
            void update_sonar(const wxImage& walls_image, int x, int y,
146 eb9cff77 Hui Jun Tay
                              double robot_theta, wxMemoryDC& sonar_dc);
147 a2e6bd4c Alex
            void update_linesensor(const wxImage& lines_image, int x, int y,
148
                                   double theta);
149 b1fdaaf6 Hui Jun Tay
            int old_front_dx;
150
            int old_front_dy;
151
            int old_back_dx;
152
            int old_back_dy;
153
            bool isFront;
154
155 6639ce9c viki
            wxBitmap *path_bitmap;
156 eb9cff77 Hui Jun Tay
            bool sonar_visual_on;
157
        bool sonar_on;
158 266ae7f2 Alex Zirbel
159 144137a1 Alex Zirbel
            ros::NodeHandle node;
160 266ae7f2 Alex Zirbel
161 144137a1 Alex Zirbel
            wxImage scout_image;
162
            wxBitmap scout;
163 266ae7f2 Alex Zirbel
164 144137a1 Alex Zirbel
            Vector2 pos;
165
            float orient;
166 266ae7f2 Alex Zirbel
167 9f547ef7 Alex Zirbel
            /// @todo should these be an array or something?
168
169 a8480867 Alex Zirbel
            // Keep track of the last commanded speeds sent to the sim
170 144137a1 Alex Zirbel
            int motor_fl_speed;
171
            int motor_fr_speed;
172
            int motor_bl_speed;
173
            int motor_br_speed;
174 a8480867 Alex Zirbel
175 9f547ef7 Alex Zirbel
            // Keep track of encoder ticks for each motor
176
            unsigned int fl_ticks;
177
            unsigned int fr_ticks;
178
            unsigned int bl_ticks;
179
            unsigned int br_ticks;
180
181 a2e6bd4c Alex
            int sonar_position;
182
            int sonar_stop_l;
183
            int sonar_stop_r;
184
            int sonar_direction;
185
            // The last time the sonar changed its position.
186
            ros::Time last_sonar_time;
187
            ros::Duration sonar_tick_time;
188
189 ade1b7f9 Alex
            // A vector of the 8 linesensor readings
190
            std::vector<unsigned int> linesensor_readings;
191
192 c492be62 Alex Zirbel
            // Each scout has a unique id number, which is also displayed on its image.
193
            int scout_id;
194
195 144137a1 Alex Zirbel
            bool pen_on;
196
            wxPen pen;
197 266ae7f2 Alex Zirbel
198 144137a1 Alex Zirbel
            ros::Subscriber motors_sub;
199
            ros::Publisher pose_pub;
200
            ros::Publisher color_pub;
201 a2e6bd4c Alex
            ros::Publisher sonar_pub;
202 144137a1 Alex Zirbel
            ros::ServiceServer set_pen_srv;
203 9f547ef7 Alex Zirbel
            ros::ServiceServer query_encoders_srv;
204 af0d9743 Alex
            ros::ServiceServer query_linesensor_srv;
205 eb9cff77 Hui Jun Tay
            ros::ServiceServer toggle_sonar_srv;
206
            ros::ServiceServer set_sonar_srv;
207 266ae7f2 Alex Zirbel
208 144137a1 Alex Zirbel
            ros::WallTime last_command_time;
209 266ae7f2 Alex Zirbel
210 144137a1 Alex Zirbel
            float meter;
211 266ae7f2 Alex Zirbel
212
    };
213
    typedef boost::shared_ptr<Scout> ScoutPtr;
214
215 4612f7e4 Alex Zirbel
}
216 266ae7f2 Alex Zirbel
217
#endif