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         f64 left_ext_gain;
  73
  74         int32_t (*right_ext_encoder)(void *);
  75         void* right_ext_encoder_param;
  76         f64 right_ext_gain;
  77
  78         /* PWM */
  79         void (*left_pwm)(void *, int32_t);
  80         void *left_pwm_param;
  81         void (*right_pwm)(void *, int32_t);
  82         void *right_pwm_param;
  83 };
  84
  85 /** Set the structure to 0 */
  86 void rs_init( struct robot_system * );
  87
  88 /**** ACCESSORS */
  89
  90 #ifdef CONFIG_MODULE_ROBOT_SYSTEM_MOT_AND_EXT
  91 /** define ratio between mot and ext track. (track_mot / track_ext) */
  92 void rs_set_ratio(struct robot_system * rs, double ratio);
  93 #endif
  94
  95 /** define left PWM function and param */
  96 void rs_set_left_pwm(struct robot_system * rs, void (*left_pwm)(void *, int32_t), void *left_pwm_param);
  97
  98 /** define right PWM function and param */
  99 void rs_set_right_pwm(struct robot_system * rs, void (*right_pwm)(void *, int32_t), void *right_pwm_param);
 100
 101 #ifdef CONFIG_MODULE_ROBOT_SYSTEM_MOT_AND_EXT
 102 /** define left motor encoder function and param */
 103 void rs_set_left_mot_encoder(struct robot_system * rs, int32_t (*left_mot_encoder)(void *),
 104                              void *left_mot_encoder_param, double gain);
 105
 106 /** define right motor encoder function and param */
 107 void rs_set_right_mot_encoder(struct robot_system * rs, int32_t (*right_mot_encoder)(void *),
 108                               void *right_mot_encoder_param, double gain);
 109 #endif
 110
 111 /** define left external encoder function and param */
 112 void rs_set_left_ext_encoder(struct robot_system * rs, int32_t (*left_ext_encoder)(void *),
 113                              void *left_ext_encoder_param, double gain);
 114
 115 /** define right external encoder function and param */
 116 void rs_set_right_ext_encoder(struct robot_system * rs, int32_t (*right_ext_encoder)(void *),
 117                               void *right_ext_encoder_param, double gain);
 118
 119 /**** Virtual encoders and PWM */
 120
 121 /**
 122  * set the real pwms according to the specified angle (it also
 123  * depends on the last distance command sent)
 124  */
 125 void rs_set_angle(void * rs, int32_t angle);
 126
 127 /**
 128  * set the real pwms according to the specified distance (it also
 129  * depends on the last angle command sent)
 130  */
 131 void rs_set_distance(void * rs, int32_t distance);
 132
 133 /**
 134  * get the virtual angle according to real encoders value.
 135  */
 136 int32_t rs_get_angle(void * rs);
 137
 138 /**
 139  * get the virtual distance according to real encoders value.
 140  */
 141 int32_t rs_get_distance(void * rs);
 142
 143 /**
 144  * get the angle according to ext encoders value.
 145  */
 146 int32_t rs_get_ext_angle(void * rs);
 147
 148 /**
 149  * get the distance according to ext encoders value.
 150  */
 151 int32_t rs_get_ext_distance(void * rs);
 152
 153 #ifdef CONFIG_MODULE_ROBOT_SYSTEM_MOT_AND_EXT
 154 /**
 155  * get the angle according to mot encoders value.
 156  */
 157 int32_t rs_get_mot_angle(void * rs);
 158
 159 /**
 160  * get the distance according to mot encoders value.
 161  */
 162 int32_t rs_get_mot_distance(void * rs);
 163 #endif
 164
 165 /* same for left/right */
 166 int32_t rs_get_ext_left(void * rs);
 167 int32_t rs_get_ext_right(void * rs);
 168 #ifdef CONFIG_MODULE_ROBOT_SYSTEM_MOT_AND_EXT
 169 int32_t rs_get_mot_left(void * rs);
 170 int32_t rs_get_mot_right(void * rs);
 171 #endif
 172
 173
 174 /**
 175  * Read the encoders, and update internal virtual counters. Call this
 176  * function is needed before reading the virtual encoders. The program
 177  * will decide if it the external encoders or the motor encoders are
 178  * taken in account (depending on flags, but not yet)
 179  */
 180 void rs_update(void * rs);
 181
 182 void rs_set_flags(struct robot_system * rs, uint8_t flags);
 183
 184
 185 #endif /* #ifndef _ROBOT_SYSTEM */