modules/devices/robot/robot_system/robot_system.h

   1 /*
   2  *  Copyright Droids Corporation, Microb Technology, Eirbot (2005)
   3  *
   4  *  This program is free software; you can redistribute it and/or modify
   5  *  it under the terms of the GNU General Public License as published by
   6  *  the Free Software Foundation; either version 2 of the License, or
   7  *  (at your option) any later version.
   8  *
   9  *  This program is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *  GNU General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License
  15  *  along with this program; if not, write to the Free Software
  16  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  *
  18  *  Revision : $Id: robot_system.h,v 1.5.4.3 2008-04-06 17:33:57 zer0 Exp $
  19  *
  20  */
  21
  22 /**
  23  * The goal of this module is to provide an interface to motor and
  24  * encoders of the robot. This module provide a function that returns
  25  * the value of virtual encoders containing distance and angle. It
  26  * also allow the user to command virtual angle and distance PWMs.
  27  */
  28
  29 #include <aversive.h>
  30 #include <f64.h>
  31
  32 #include "angle_distance.h"
  33
  34 #ifndef _ROBOT_SYSTEM_H_
  35 #define _ROBOT_SYSTEM_H_
  36
  37 /* flags */
  38 #define RS_USE_EXT 1
  39 #define RS_IGNORE_EXT_GAIN 2
  40 #define RS_IGNORE_MOT_GAIN 4
  41
  42
  43 struct robot_system
  44 {
  45         uint8_t flags;
  46
  47 #ifdef CONFIG_MODULE_ROBOT_SYSTEM_MOT_AND_EXT
  48         struct rs_polar pmot_prev;
  49         struct rs_wheels wmot_prev;
  50
  51         f64 ratio_mot_ext;
  52
  53         /* Motor encoders */
  54         int32_t (*left_mot_encoder)(void *);
  55         void* left_mot_encoder_param;
  56         f64 left_mot_gain;
  57
  58         int32_t (*right_mot_encoder)(void *);
  59         void* right_mot_encoder_param;
  60         f64 right_mot_gain;
  61 #endif
  62
  63         struct rs_polar virtual_pwm;
  64         struct rs_polar virtual_encoders;
  65
  66         struct rs_polar pext_prev;
  67         struct rs_wheels wext_prev;
  68
  69         /* External encoders */
  70         int32_t (*left_ext_encoder)(void *);
  71         void* left_ext_encoder_param;
  72 #ifdef CONFIG_MODULE_ROBOT_SYSTEM_USE_F64
  73         f64 left_ext_gain;
  74 #else
  75         double left_ext_gain;
  76 #endif
  77
  78         int32_t (*right_ext_encoder)(void *);
  79         void* right_ext_encoder_param;
  80 #ifdef CONFIG_MODULE_ROBOT_SYSTEM_USE_F64
  81         f64 right_ext_gain;
  82 #else
  83         double right_ext_gain;
  84 #endif
  85
  86         /* PWM */
  87         void (*left_pwm)(void *, int32_t);
  88         void *left_pwm_param;
  89         void (*right_pwm)(void *, int32_t);
  90         void *right_pwm_param;
  91 };
  92
  93 /** Set the structure to 0 */
  94 void rs_init( struct robot_system * );
  95
  96 /**** ACCESSORS */
  97
  98 #ifdef CONFIG_MODULE_ROBOT_SYSTEM_MOT_AND_EXT
  99 /** define ratio between mot and ext track. (track_mot / track_ext) */
 100 void rs_set_ratio(struct robot_system * rs, double ratio);
 101 #endif
 102
 103 /** define left PWM function and param */
 104 void rs_set_left_pwm(struct robot_system * rs, void (*left_pwm)(void *, int32_t), void *left_pwm_param);
 105
 106 /** define right PWM function and param */
 107 void rs_set_right_pwm(struct robot_system * rs, void (*right_pwm)(void *, int32_t), void *right_pwm_param);
 108
 109 #ifdef CONFIG_MODULE_ROBOT_SYSTEM_MOT_AND_EXT
 110 /** define left motor encoder function and param */
 111 void rs_set_left_mot_encoder(struct robot_system * rs, int32_t (*left_mot_encoder)(void *),
 112                              void *left_mot_encoder_param, double gain);
 113
 114 /** define right motor encoder function and param */
 115 void rs_set_right_mot_encoder(struct robot_system * rs, int32_t (*right_mot_encoder)(void *),
 116                               void *right_mot_encoder_param, double gain);
 117 #endif
 118
 119 /** define left external encoder function and param */
 120 void rs_set_left_ext_encoder(struct robot_system * rs, int32_t (*left_ext_encoder)(void *),
 121                              void *left_ext_encoder_param, double gain);
 122
 123 /** define right external encoder function and param */
 124 void rs_set_right_ext_encoder(struct robot_system * rs, int32_t (*right_ext_encoder)(void *),
 125                               void *right_ext_encoder_param, double gain);
 126
 127 /**** Virtual encoders and PWM */
 128
 129 /**
 130  * set the real pwms according to the specified angle (it also
 131  * depends on the last distance command sent)
 132  */
 133 void rs_set_angle(void * rs, int32_t angle);
 134
 135 /**
 136  * set the real pwms according to the specified distance (it also
 137  * depends on the last angle command sent)
 138  */
 139 void rs_set_distance(void * rs, int32_t distance);
 140
 141 /**
 142  * get the virtual angle according to real encoders value.
 143  */
 144 int32_t rs_get_angle(void * rs);
 145
 146 /**
 147  * get the virtual distance according to real encoders value.
 148  */
 149 int32_t rs_get_distance(void * rs);
 150
 151 /**
 152  * get the angle according to ext encoders value.
 153  */
 154 int32_t rs_get_ext_angle(void * rs);
 155
 156 /**
 157  * get the distance according to ext encoders value.
 158  */
 159 int32_t rs_get_ext_distance(void * rs);
 160
 161 #ifdef CONFIG_MODULE_ROBOT_SYSTEM_MOT_AND_EXT
 162 /**
 163  * get the angle according to mot encoders value.
 164  */
 165 int32_t rs_get_mot_angle(void * rs);
 166
 167 /**
 168  * get the distance according to mot encoders value.
 169  */
 170 int32_t rs_get_mot_distance(void * rs);
 171 #endif
 172
 173 /* same for left/right */
 174 int32_t rs_get_ext_left(void * rs);
 175 int32_t rs_get_ext_right(void * rs);
 176 #ifdef CONFIG_MODULE_ROBOT_SYSTEM_MOT_AND_EXT
 177 int32_t rs_get_mot_left(void * rs);
 178 int32_t rs_get_mot_right(void * rs);
 179 #endif
 180
 181
 182 /**
 183  * Read the encoders, and update internal virtual counters. Call this
 184  * function is needed before reading the virtual encoders. The program
 185  * will decide if it the external encoders or the motor encoders are
 186  * taken in account (depending on flags, but not yet)
 187  */
 188 void rs_update(void * rs);
 189
 190 void rs_set_flags(struct robot_system * rs, uint8_t flags);
 191
 192
 193 #endif /* #ifndef _ROBOT_SYSTEM */