modules/devices/encoders/encoders_eirbot/encoders_eirbot.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: encoders_eirbot.h,v 1.3.4.2 2007-05-23 17:18:13 zer0 Exp $
  19  *
  20  */
  21
  22 /** \file encoders_eirbot.h
  23  *  \brief universal Interface for incremental coders
  24  */
  25
  26 #ifndef _ENCODERS_EIRBOT_H_
  27 #define _ENCODERS_EIRBOT_H_
  28
  29 #include <base/utils/aversive.h>
  30 #include <encoders_eirbot_config.h>
  31
  32 typedef int32_t encoders;
  33
  34 /**
  35  * Initialisation of counters, variables
  36  */
  37 void encoders_init(void);
  38
  39
  40 /**
  41  * Update counter values, need to be done quite (depends on which counter)
  42  */
  43 void encoders_manage(void);
  44
  45
  46 /** Extract counter value */
  47 encoders encoders_get_value(uint8_t number);
  48
  49 #endif