scoutos / scout / encoders / src / encoders.cpp @ 3a73516c
History | View | Annotate | Download (4.32 KB)
1 | 14241f84 | Lalitha Ganesan | /**
|
---|---|---|---|
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 | c492be62 | Alex Zirbel | */
|
25 | 14241f84 | Lalitha Ganesan | |
26 | /**
|
||
27 | * @file encoders.cpp
|
||
28 | * @brief Encoders
|
||
29 | *
|
||
30 | 3a73516c | Alex | * @defgroup encoders Encoders
|
31 | * @brief Functions for using the encoders
|
||
32 | 14241f84 | Lalitha Ganesan | *
|
33 | * @author Colony Project, CMU Robotics Club
|
||
34 | ce559b91 | Alex Zirbel | * @author Alex Zirbel
|
35 | d7c3c222 | Tom Mullins | * @author Tom Mullins
|
36 | 14241f84 | Lalitha Ganesan | |
37 | ce559b91 | Alex Zirbel | * @{
|
38 | 126fea96 | Alex | **/
|
39 | |||
40 | dbbad8ed | Tom Mullins | #include <fstream> |
41 | 126fea96 | Alex | #include <ros/ros.h> |
42 | #include "encoders.h" |
||
43 | 14241f84 | Lalitha Ganesan | |
44 | d7c3c222 | Tom Mullins | /* Encoder instances */
|
45 | /* @todo make sure these are the correct numbers */
|
||
46 | static Encoder encoder_fl(0); |
||
47 | static Encoder encoder_fr(1); |
||
48 | static Encoder encoder_bl(2); |
||
49 | static Encoder encoder_br(3); |
||
50 | ce559b91 | Alex Zirbel | |
51 | d7c3c222 | Tom Mullins | /**
|
52 | * @brief Encoder constructor
|
||
53 | *
|
||
54 | * Opens device file, which is read at every call to get_ticks
|
||
55 | *
|
||
56 | * @param n The encoder number to read, between 0 and 3 inclusive
|
||
57 | */
|
||
58 | Encoder::Encoder(int n)
|
||
59 | { |
||
60 | f358d0b2 | Colony Scout | sprintf(filename, "/sys/class/encoder/enc%d/ticks", n);
|
61 | d7c3c222 | Tom Mullins | } |
62 | |||
63 | /**
|
||
64 | * @brief Returns the current tick count
|
||
65 | *
|
||
66 | * This will actually read from the encoder ticks file to get the latest value
|
||
67 | * from the driver
|
||
68 | */
|
||
69 | int Encoder::get_ticks()
|
||
70 | { |
||
71 | f358d0b2 | Colony Scout | // open device file
|
72 | dbbad8ed | Tom Mullins | std::fstream fticks(filename, std::ios::in); |
73 | f358d0b2 | Colony Scout | |
74 | d7c3c222 | Tom Mullins | int ticks;
|
75 | fticks >> ticks; |
||
76 | f358d0b2 | Colony Scout | |
77 | d7c3c222 | Tom Mullins | return ticks;
|
78 | } |
||
79 | 7cb5de78 | Ben Wasserman | |
80 | ce559b91 | Alex Zirbel | /**
|
81 | dbbad8ed | Tom Mullins | * @brief Resets the encoder
|
82 | *
|
||
83 | * Sets the encoder's ticks value back to 0
|
||
84 | */
|
||
85 | void Encoder::reset()
|
||
86 | { |
||
87 | std::fstream fticks(filename, std::ios::out); |
||
88 | fticks << 0;
|
||
89 | } |
||
90 | |||
91 | /**
|
||
92 | ce559b91 | Alex Zirbel | * @brief Outputs current encoder data
|
93 | *
|
||
94 | * Serves the service query_encoders by responding to service requests with the
|
||
95 | * encoder values.
|
||
96 | * @param req The request. The units that the response should be in.
|
||
97 | * @param res The response. The fields will be filled with values.
|
||
98 | */
|
||
99 | 6ebee82c | Alex | bool handle_encoders_query(::messages::query_encoders::Request &req,
|
100 | ::messages::query_encoders::Response &res) |
||
101 | ce559b91 | Alex Zirbel | { |
102 | /* Put index, velocity, and distance data in message */
|
||
103 | 259aaff8 | Colony Scout | res.fl_distance = -encoder_fl.get_ticks(); |
104 | d7c3c222 | Tom Mullins | res.fr_distance = encoder_fr.get_ticks(); |
105 | res.bl_distance = encoder_bl.get_ticks(); |
||
106 | res.br_distance = encoder_br.get_ticks(); |
||
107 | ce559b91 | Alex Zirbel | |
108 | d7c3c222 | Tom Mullins | /* @todo maybe return value based on whether reads succeeded */
|
109 | |||
110 | ROS_DEBUG("Encoder values queried");
|
||
111 | f358d0b2 | Colony Scout | ROS_INFO("Encoder values queried %d %d %d %d", res.fl_distance, res.fr_distance, res.bl_distance, res.br_distance);
|
112 | ce559b91 | Alex Zirbel | return true; |
113 | } |
||
114 | 14241f84 | Lalitha Ganesan | |
115 | ce559b91 | Alex Zirbel | /**
|
116 | dbbad8ed | Tom Mullins | * @brief Resets all four encoders
|
117 | *
|
||
118 | * Serves the service reset_encoders
|
||
119 | * @param req The request. Empty.
|
||
120 | * @param res The response. Empty.
|
||
121 | */
|
||
122 | bool handle_reset_query(::messages::reset_encoders::Request &req,
|
||
123 | ::messages::reset_encoders::Response &res) |
||
124 | { |
||
125 | encoder_fl.reset(); |
||
126 | encoder_fr.reset(); |
||
127 | encoder_bl.reset(); |
||
128 | encoder_br.reset(); |
||
129 | return true; |
||
130 | } |
||
131 | |||
132 | /**
|
||
133 | ce559b91 | Alex Zirbel | * @brief Encoders driver. This is a ROS node that controls encoders.
|
134 | 14241f84 | Lalitha Ganesan | *
|
135 | * This is the main function for the encoders node. It is run when the node
|
||
136 | * starts and initializes the encoders. It then publishes to the
|
||
137 | * encoder_state topic and advertises the query_encoders service.
|
||
138 | ce559b91 | Alex Zirbel | */
|
139 | int main(int argc, char **argv) |
||
140 | { |
||
141 | /* Initialize in ROS the encoders driver node */
|
||
142 | ros::init(argc, argv, "encoders_driver");
|
||
143 | 14241f84 | Lalitha Ganesan | |
144 | ce559b91 | Alex Zirbel | /* Advertise that this serves the query_encoders service */
|
145 | ros::NodeHandle n; |
||
146 | ros::ServiceServer service = |
||
147 | n.advertiseService("query_encoders",
|
||
148 | handle_encoders_query); |
||
149 | 14241f84 | Lalitha Ganesan | |
150 | ce559b91 | Alex Zirbel | ROS_INFO("Ready to set encoders.");
|
151 | 14241f84 | Lalitha Ganesan | |
152 | ce559b91 | Alex Zirbel | ros::spin(); |
153 | 14241f84 | Lalitha Ganesan | |
154 | ce559b91 | Alex Zirbel | return 0; |
155 | 14241f84 | Lalitha Ganesan | } |
156 | |||
157 | ce559b91 | Alex Zirbel | /** @} */ |