Statistics
| Branch: | Revision:

scoutos / scout / scoutsim / src / scout.h @ 71e1154d

History | View | Annotate | Download (6.65 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

    
60
#include <scoutsim/Pose.h>
61
#include <scoutsim/SetPen.h>
62
#include <scoutsim/Color.h>
63

    
64
#include <geometry_msgs/Pose2D.h>
65

    
66
#include <wx/wx.h>
67

    
68
#include "scoutsim_internal.h"
69
#include "scout_constants.h"
70

    
71
#define PI 3.14159265
72

    
73
/// The scale factor so the speed of scout robots is reasonable for the sim
74
#define SPEED_SCALE_FACTOR 0.05
75

    
76
#define NUM_LINESENSORS 8
77

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

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

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

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

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

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

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

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

    
123
        private:
124
            void setMotors(const motors::set_motors::ConstPtr& msg);
125
            bool setPenCallback(scoutsim::SetPen::Request&,
126
                                scoutsim::SetPen::Response&);
127
            bool query_encoders_callback(encoders::query_encoders::Request&,
128
                                         encoders::query_encoders::Response&);
129
            bool query_linesensor_callback(linesensor::query_linesensor::Request&,
130
                                           linesensor::query_linesensor::Response&);
131
            unsigned int rgb_to_grey(unsigned char r,
132
                                     unsigned char g,
133
                                     unsigned char b);
134
            unsigned int trace_sonar(const wxImage& walls_image, int x, int y,
135
                                     double robot_theta, int sonar_pos);
136
            void update_sonar(const wxImage& walls_image, int x, int y,
137
                              double robot_theta);
138
            void update_linesensor(const wxImage& lines_image, int x, int y,
139
                                   double theta);
140

    
141
            ros::NodeHandle node;
142

    
143
            wxImage scout_image;
144
            wxBitmap scout;
145

    
146
            Vector2 pos;
147
            float orient;
148

    
149
            /// @todo should these be an array or something?
150

    
151
            // Keep track of the last commanded speeds sent to the sim
152
            int motor_fl_speed;
153
            int motor_fr_speed;
154
            int motor_bl_speed;
155
            int motor_br_speed;
156

    
157
            // Keep track of encoder ticks for each motor
158
            unsigned int fl_ticks;
159
            unsigned int fr_ticks;
160
            unsigned int bl_ticks;
161
            unsigned int br_ticks;
162

    
163
            int sonar_position;
164
            int sonar_stop_l;
165
            int sonar_stop_r;
166
            int sonar_direction;
167
            // The last time the sonar changed its position.
168
            ros::Time last_sonar_time;
169
            ros::Duration sonar_tick_time;
170

    
171
            // A vector of the 8 linesensor readings
172
            std::vector<unsigned int> linesensor_readings;
173

    
174
            // Each scout has a unique id number, which is also displayed on its image.
175
            int scout_id;
176

    
177
            bool pen_on;
178
            wxPen pen;
179

    
180
            ros::Subscriber motors_sub;
181
            ros::Publisher pose_pub;
182
            ros::Publisher color_pub;
183
            ros::Publisher sonar_pub;
184
            ros::ServiceServer set_pen_srv;
185
            ros::ServiceServer query_encoders_srv;
186
            ros::ServiceServer query_linesensor_srv;
187

    
188
            ros::WallTime last_command_time;
189

    
190
            float meter;
191

    
192
    };
193
    typedef boost::shared_ptr<Scout> ScoutPtr;
194

    
195
}
196

    
197
#endif