Revision 65c7f52b

View differences:

scout/libscout/src/SonarControl.cpp
1
/**
2
 * Copyright (c) 2011 Colony Project
3
 * 
4
 * Permission is hereby granted, free of charge, to any person
5
 * obtaining a copy of this software and associated documentation
6
 * files (the "Software"), to deal in the Software without
7
 * restriction, including without limitation the rights to use,
8
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
9
 * copies of the Software, and to permit persons to whom the
10
 * Software is furnished to do so, subject to the following
11
 * conditions:
12
 * 
13
 * The above copyright notice and this permission notice shall be
14
 * included in all copies or substantial portions of the Software.
15
 * 
16
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
18
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
21
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23
 * OTHER DEALINGS IN THE SOFTWARE.
24
 **/
25

  
26
/**
27
 * @file SonarControl.cpp
28
 * @brief Contains sonar function imeplementations
29
 * 
30
 * Contains functions for the use of sonar control.
31
 *
32
 * @author Colony Project, CMU Robotics Club
33
 * @author Priyanka Deo
34
 **/
35

  
36
#include "SonarControl.h"
37

  
38
/**
39
 * @brief Initialize the sonar module of libscout.
40
 *
41
 * Initialize the libscout node as a publisher of sonar_set_scan and 
42
 * sonar_toggle and a client of query_sonar.
43
 */
44
SonarControl::SonarControl(const ros::NodeHandle& libscout_node)
45
    : node(libscout_node)
46
{
47
    sonar_set_scan_pub =
48
        node.advertise<sonar::sonar_set_scan>("set_sonar_scan", QUEUE_SIZE);
49
    sonar_toggle_pub = 
50
	node.advertise<sonar::sonar_toggle>("toggle_sonar", QUEUE_SIZE);
51
    query_sonar =
52
        node.serviceClient<sonar::sonar_direction>("query_sonar");
53
}
54

  
55
/**
56
 * @brief Sets the sonar to a position.
57
 *
58
 * @param position Value between 0-180 of degree position to set sonar
59
 * @return NONE
60
 */
61
void SonarControl::set(int position)
62
{
63
    set_range(position, position);
64
}
65

  
66
/**
67
 * @brief Sets the sonar to scan between two positions
68
 *
69
 * @param start_pos The leftmost (smallest) value that the sonar can take
70
 * @param end_pos The rightmost (largest) value that the sonar can take
71
 * @return NONE
72
 */
73
void SonarControl::set_range(int start_pos, int end_pos)
74
{
75
    //TODO Enable some checks of start and end position
76
    sonar::sonar_set_scan msg;
77

  
78
    msg.stop_l = start_pos;
79
    msg.stop_r = end_pos;
80

  
81
    sonar_set_scan_pub.publish(msg);
82
    ros::spinOnce();
83
}
84

  
85
/**
86
 * @brief Query the current front sonar readings
87
 *
88
 * Sends a request to the query_sonar service which will reply with the
89
 *  current readings of the sonar.
90
 *
91
 * @TODO Change so we can get multiple sonar readings with one call
92
 *
93
 * @return The reading of the front sonar or LIB_ERR.
94
 */
95
float SonarControl::query_front()
96
{
97
    sonar::sonar_direction srv;
98
    if(query_sonar.call(srv))
99
    {
100
        srv.response.distance0;
101
    }
102
    else
103
    {
104
        ROS_ERROR("Failed to call service query_motors");
105
        return LIB_ERROR;
106
    }
107

  
108
    return 0;
109
}
110

  
111
/**
112
 * @brief Query the current back sonar readings
113
 *
114
 * Sends a request to the query_sonar service which will reply with the
115
 *  current readings of the sonar.
116
 *
117
 * @TODO Change so we can get multiple sonar readings with one call
118
 *
119
 * @return The reading of the back sonar or LIB_ERR.
120
 */
121
float SonarControl::query_back()
122
{
123
    sonar::sonar_direction srv;
124
    if(query_sonar.call(srv))
125
    {
126
        srv.response.distance1;
127
    }
128
    else
129
    {
130
        ROS_ERROR("Failed to call service query_motors");
131
        return LIB_ERROR;
132
    }
133

  
134
    return 0;
135
}
136

  
137
/**
138
 * @brief Converts value returne by sonar to physical distances.
139
 *
140
 * @param sonar_value The returned value of the sonar
141
 * @return The physical distance measured by the sonar.
142
 **/
143
float sonar_to_dist(float sonar_value)
144
{
145
    //TODO impelement later based on sonar readings
146
    return sonar_value;
147
}
148

  
149
/**
150
 * @brief Converts values from physical distances to values read by sonar
151
 *
152
 * @param distance The physical distance as measured.
153
 * @return The value read by the sonar that corresponds to the given distance
154
 **/
155
float dist_to_sonar(float distance)
156
{
157
    //TODO implement later based on sonar readings
158
    return distance;
159
}
scout/libscout/src/SonarControl.h
1
/**
2
 * Copyright (c) 2011 Colony Project
3
 * 
4
 * Permission is hereby granted, free of charge, to any person
5
 * obtaining a copy of this software and associated documentation
6
 * files (the "Software"), to deal in the Software without
7
 * restriction, including without limitation the rights to use,
8
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
9
 * copies of the Software, and to permit persons to whom the
10
 * Software is furnished to do so, subject to the following
11
 * conditions:
12
 * 
13
 * The above copyright notice and this permission notice shall be
14
 * included in all copies or substantial portions of the Software.
15
 * 
16
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
18
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
21
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23
 * OTHER DEALINGS IN THE SOFTWARE.
24
 **/
25

  
26
/**
27
 * @file SonarControl.h
28
 * @brief Contains sonar declarations and functions
29
 * 
30
 * Contains functions and definitions for the use of
31
 * sonar
32
 *
33
 * @author Colony Project, CMU Robotics Club
34
 * @author Priyanka Deo
35
 **/
36

  
37
#ifndef _SONAR_CONTROL_H_
38
#define _SONAR_CONTROL_H_
39

  
40
#include <ros/ros.h>
41
/// @TODO maybe not so good! Then packages have to depend on libscout.
42
#include <libscout/constants.h>
43
#include <sonar/sonar_set_scan.h>
44
#include <sonar/sonar_toggle.h>
45
#include <sonar/sonar_direction.h>
46

  
47
class SonarControl
48
{
49
    public:
50
        /** Set up the motor node and prepare to communicate over ROS */
51
        SonarControl(const ros::NodeHandle& libscout_node);
52

  
53
        /** Sets sonar to a position (0-180 deg) specified by input */
54
        void set(int position);
55

  
56
	/** Sets sonar to scan a range in 0-180 specified by input */
57
	void set_range(int start_pos, int end_pos);	
58

  
59
        /** Returns the distance readings of sonars */
60
        float query_front(void);
61
	float query_back(void);
62
    
63
    private:
64
	/** Converts between values outputted by sensor and physical distances */
65
        float sonar_to_dist(float sonar_value);
66
        float dist_to_sonar(float distance);
67

  
68
        /* Front and back distance values read by sonar. */
69
        float front_dist;
70
        float back_dist;
71

  
72
        /** ROS publisher and client declaration */
73
        ros::Publisher sonar_set_scan_pub;
74
	ros::Publisher sonar_toggle_pub;
75
        ros::ServiceClient query_sonar;
76

  
77
        ros::NodeHandle node;
78

  
79
};
80

  
81
#endif
82

  

Also available in: Unified diff