Statistics
| Branch: | Revision:

root / scout / encoders / src / encoders.cpp @ 6ebee82c

History | View | Annotate | Download (3.67 KB)

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 encoders.cpp
28
 * @brief Encoders
29
 *
30
 * Implementation of functions for encoder use.
31
 *
32
 * @author Colony Project, CMU Robotics Club
33
 * @author Alex Zirbel
34
 * @author Tom Mullins
35
 **/
36

    
37
#include <ros/ros.h>
38
#include "encoders.h"
39

    
40
/**
41
 * @defgroup encoders Encoders
42
 * @brief Functions for using the encoders
43
 *
44
 * @{
45
 */
46

    
47
/* Encoder instances */
48
/* @todo make sure these are the correct numbers */
49
static Encoder encoder_fl(0);
50
static Encoder encoder_fr(1);
51
static Encoder encoder_bl(2);
52
static Encoder encoder_br(3);
53

    
54
/**
55
 * @brief Encoder constructor
56
 *
57
 * Opens device file, which is read at every call to get_ticks
58
 *
59
 * @param n The encoder number to read, between 0 and 3 inclusive
60
 */
61
Encoder::Encoder(int n)
62
{
63
    char buf[60];
64

    
65
    // open device file
66
    sprintf(buf, "/sys/class/encoder/enc%d/ticks", n);
67
    fticks.open(buf, std::ios::in);
68
}
69

    
70
/**
71
 * @brief Returns the current tick count
72
 *
73
 * This will actually read from the encoder ticks file to get the latest value
74
 * from the driver
75
 */
76
int Encoder::get_ticks()
77
{
78
    int ticks;
79
    fticks >> ticks;
80
    return ticks;
81
}
82

    
83
/**
84
 * @brief Outputs current encoder data
85
 *
86
 * Serves the service query_encoders by responding to service requests with the
87
 * encoder values.
88
 * @param req The request. The units that the response should be in.
89
 * @param res The response. The fields will be filled with values.
90
 */
91
bool handle_encoders_query(::messages::query_encoders::Request  &req,
92
                           ::messages::query_encoders::Response &res)
93
{
94
    /* Put index, velocity, and distance data in message */
95
    res.fl_distance = encoder_fl.get_ticks();
96
    res.fr_distance = encoder_fr.get_ticks();
97
    res.bl_distance = encoder_bl.get_ticks();
98
    res.br_distance = encoder_br.get_ticks();
99

    
100
    /* @todo maybe return value based on whether reads succeeded */
101

    
102
    ROS_DEBUG("Encoder values queried");
103
    return true;
104
}
105

    
106
/**
107
 * @brief Encoders driver. This is a ROS node that controls encoders.
108
 *
109
 * This is the main function for the encoders node. It is run when the node
110
 * starts and initializes the encoders. It then publishes to the
111
 * encoder_state topic and advertises the query_encoders service.
112
 */
113
int main(int argc, char **argv)
114
{
115
    /* Initialize in ROS the encoders driver node */
116
    ros::init(argc, argv, "encoders_driver");
117

    
118
    /* Advertise that this serves the query_encoders service */
119
    ros::NodeHandle n;
120
    ros::ServiceServer service =
121
        n.advertiseService("query_encoders",
122
                           handle_encoders_query);
123

    
124
    ROS_INFO("Ready to set encoders.");
125

    
126
    ros::spin();
127

    
128
    return 0;
129
}
130

    
131
/** @} */