Statistics
| Branch: | Revision:

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

History | View | Annotate | Download (7.55 KB)

1
/**
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
 *
6
 * 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
 * All rights reserved.
25
 * 
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
 */
47

    
48
#ifndef _SCOUTSIM_SCOUT_H_
49
#define _SCOUTSIM_SCOUT_H_
50

    
51
#include <ros/ros.h>
52
#include <vector>
53
#include <boost/shared_ptr.hpp>
54

    
55
#include <motors/set_motors.h>
56
#include <encoders/query_encoders.h>
57
#include <linesensor/query_linesensor.h>
58
#include <sonar/sonar_distance.h>
59
#include <sonar/sonar_toggle.h>
60
#include <sonar/sonar_set_scan.h>
61

    
62
#include <scoutsim/Pose.h>
63
#include <scoutsim/SetPen.h>
64
#include <scoutsim/Color.h>
65

    
66
#include <geometry_msgs/Pose2D.h>
67

    
68
#include <wx/wx.h>
69

    
70
#include "scoutsim_internal.h"
71
#include "scout_constants.h"
72

    
73
#define PI 3.14159265
74

    
75
#define NUM_LINESENSORS 8
76

    
77
// Distance, pixels, from center of robot to the linesensors.
78
#define LNSNSR_D 20
79

    
80
namespace scoutsim
81
{
82
    struct Vector2
83
    {
84
        Vector2()
85
            : x(0.0)
86
              , y(0.0)
87
        {}
88

    
89
        Vector2(float new_x, float new_y)
90
            : x(new_x)
91
              , y(new_y)
92
        {}
93

    
94
        bool operator==(const Vector2& rhs)
95
        {
96
            return x == rhs.x && y == rhs.y;
97
        }
98

    
99
        bool operator!=(const Vector2& rhs)
100
        {
101
            return x != rhs.x || y != rhs.y;
102
        }
103

    
104
        float x;
105
        float y;
106
    };
107

    
108
    class Scout
109
    {
110
        public:
111
            Scout(const ros::NodeHandle& nh,const wxImage& scout_image,
112
                  const Vector2& pos, wxBitmap *path_bitmap, float orient);
113

    
114
            geometry_msgs::Pose2D update(double dt, wxMemoryDC& path_dc,
115
                                         wxMemoryDC& sonar_dc,
116
                                         const wxImage& path_image,
117
                                         const wxImage& lines_image,
118
                                         const wxImage& walls_image,
119
                                         wxColour background_color,
120
                                         wxColour sonar_color,
121
                                         world_state state);
122
            void paint(wxDC& dc);
123
            void set_sonar_visual(bool on);
124

    
125
        private:
126
            float absolute_to_mps(int absolute_speed);
127
            void setMotors(const motors::set_motors::ConstPtr& msg);
128
            bool setPenCallback(scoutsim::SetPen::Request&,
129
                                scoutsim::SetPen::Response&);
130
            bool query_encoders_callback(encoders::query_encoders::Request&,
131
                                         encoders::query_encoders::Response&);
132
            bool query_linesensor_callback(linesensor::query_linesensor::Request&,
133
                                           linesensor::query_linesensor::Response&);
134
            bool handle_sonar_toggle(sonar::sonar_toggle::Request  &req,
135
                                     sonar::sonar_toggle::Response &res);
136
            bool handle_sonar_set_scan(sonar::sonar_set_scan::Request  &req,
137
                                       sonar::sonar_set_scan::Response &res);
138
            unsigned int rgb_to_grey(unsigned char r,
139
                                     unsigned char g,
140
                                     unsigned char b);
141
            unsigned int trace_sonar(const wxImage& walls_image, int x, int y,
142
                                   double robot_theta, int sonar_pos,
143
                                    wxMemoryDC& sonar_dc);
144

    
145
            void update_sonar(const wxImage& walls_image, int x, int y,
146
                              double robot_theta, wxMemoryDC& sonar_dc);
147
            void update_linesensor(const wxImage& lines_image, int x, int y,
148
                                   double theta);
149
            int old_front_dx;
150
            int old_front_dy;
151
            int old_back_dx;
152
            int old_back_dy;
153
            bool isFront;
154

    
155
                wxBitmap *path_bitmap;
156
                bool sonar_visual_on;
157
            bool sonar_on;
158

    
159
            ros::NodeHandle node;
160

    
161
            wxImage scout_image;
162
            wxBitmap scout;
163

    
164
            Vector2 pos;
165
            float orient;
166

    
167
            /// @todo should these be an array or something?
168

    
169
            // Keep track of the last commanded speeds sent to the sim,
170
            // converted to m/s
171
            float motor_fl_speed;
172
            float motor_fr_speed;
173
            float motor_bl_speed;
174
            float motor_br_speed;
175

    
176
            // Keep track of encoder ticks for each motor
177
            unsigned int fl_ticks;
178
            unsigned int fr_ticks;
179
            unsigned int bl_ticks;
180
            unsigned int br_ticks;
181

    
182
            int sonar_position;
183
            int sonar_stop_l;
184
            int sonar_stop_r;
185
            int sonar_direction;
186

    
187
            // The last time the sonar changed its position.
188
            ros::Time last_sonar_time;
189
            ros::Duration sonar_tick_time;
190

    
191
            // A vector of the 8 linesensor readings
192
            std::vector<unsigned int> linesensor_readings;
193

    
194
            // Each scout has a unique id number, which is also displayed on its image.
195
            int scout_id;
196

    
197
            bool pen_on;
198
            wxPen pen;
199

    
200
            ros::Subscriber motors_sub;
201
            ros::Publisher pose_pub;
202
            ros::Publisher color_pub;
203
            ros::Publisher sonar_pub;
204
            ros::ServiceServer set_pen_srv;
205
            ros::ServiceServer query_encoders_srv;
206
            ros::ServiceServer query_linesensor_srv;
207
            ros::ServiceServer toggle_sonar_srv;
208
            ros::ServiceServer set_sonar_srv;
209

    
210
            ros::WallTime last_command_time;
211
    };
212
    typedef boost::shared_ptr<Scout> ScoutPtr;
213
}
214

    
215
#endif