Robot 2015 | Mbed

ARES » Code » Robot 2015

ARES / Mbed 2 deprecated Robot 2015

Dependencies: mbed

QEI/QEI.h@123:55e5e9acc541, 2015-05-11 (annotated)

Committer:: Jagang
Date:: Mon May 11 20:32:11 2015 +0000
Revision:: 123:55e5e9acc541
Parent:: 0:41149573d577
Child:: 1:c8dc3dee3b70

Maj AI; Repositionnement du d?part (1000,177); Ajout de l'action sur les claps

Who changed what in which revision?

User	Revision	Line number	New contents of line
Jagang	0:41149573d577	1	/**
Jagang	0:41149573d577	2	* @author Aaron Berk
Jagang	0:41149573d577	3	*
Jagang	0:41149573d577	4	* @section LICENSE
Jagang	0:41149573d577	5	*
Jagang	0:41149573d577	6	* Copyright (c) 2010 ARM Limited
Jagang	0:41149573d577	7	*
Jagang	0:41149573d577	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
Jagang	0:41149573d577	9	* of this software and associated documentation files (the "Software"), to deal
Jagang	0:41149573d577	10	* in the Software without restriction, including without limitation the rights
Jagang	0:41149573d577	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Jagang	0:41149573d577	12	* copies of the Software, and to permit persons to whom the Software is
Jagang	0:41149573d577	13	* furnished to do so, subject to the following conditions:
Jagang	0:41149573d577	14	*
Jagang	0:41149573d577	15	* The above copyright notice and this permission notice shall be included in
Jagang	0:41149573d577	16	* all copies or substantial portions of the Software.
Jagang	0:41149573d577	17	*
Jagang	0:41149573d577	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Jagang	0:41149573d577	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Jagang	0:41149573d577	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Jagang	0:41149573d577	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Jagang	0:41149573d577	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Jagang	0:41149573d577	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Jagang	0:41149573d577	24	* THE SOFTWARE.
Jagang	0:41149573d577	25	*
Jagang	0:41149573d577	26	* @section DESCRIPTION
Jagang	0:41149573d577	27	*
Jagang	0:41149573d577	28	* Quadrature Encoder Interface.
Jagang	0:41149573d577	29	*
Jagang	0:41149573d577	30	* A quadrature encoder consists of two code tracks on a disc which are 90
Jagang	0:41149573d577	31	* degrees out of phase. It can be used to determine how far a wheel has
Jagang	0:41149573d577	32	* rotated, relative to a known starting position.
Jagang	0:41149573d577	33	*
Jagang	0:41149573d577	34	* Only one code track changes at a time leading to a more robust system than
Jagang	0:41149573d577	35	* a single track, because any jitter around any edge won't cause a state
Jagang	0:41149573d577	36	* change as the other track will remain constant.
Jagang	0:41149573d577	37	*
Jagang	0:41149573d577	38	* Encoders can be a homebrew affair, consisting of infrared emitters/receivers
Jagang	0:41149573d577	39	* and paper code tracks consisting of alternating black and white sections;
Jagang	0:41149573d577	40	* alternatively, complete disk and PCB emitter/receiver encoder systems can
Jagang	0:41149573d577	41	* be bought, but the interface, regardless of implementation is the same.
Jagang	0:41149573d577	42	*
Jagang	0:41149573d577	43	* +-----+ +-----+ +-----+
Jagang	0:41149573d577	44	* Channel A \| ^ \| \| \| \| \|
Jagang	0:41149573d577	45	* ---+ ^ +-----+ +-----+ +-----
Jagang	0:41149573d577	46	* ^ ^
Jagang	0:41149573d577	47	* ^ +-----+ +-----+ +-----+
Jagang	0:41149573d577	48	* Channel B ^ \| \| \| \| \| \|
Jagang	0:41149573d577	49	* ------+ +-----+ +-----+ +-----
Jagang	0:41149573d577	50	* ^ ^
Jagang	0:41149573d577	51	* ^ ^
Jagang	0:41149573d577	52	* 90deg
Jagang	0:41149573d577	53	*
Jagang	0:41149573d577	54	* The interface uses X2 encoding by default which calculates the pulse count
Jagang	0:41149573d577	55	* based on reading the current state after each rising and falling edge of
Jagang	0:41149573d577	56	* channel A.
Jagang	0:41149573d577	57	*
Jagang	0:41149573d577	58	* +-----+ +-----+ +-----+
Jagang	0:41149573d577	59	* Channel A \| \| \| \| \| \|
Jagang	0:41149573d577	60	* ---+ +-----+ +-----+ +-----
Jagang	0:41149573d577	61	* ^ ^ ^ ^ ^
Jagang	0:41149573d577	62	* ^ +-----+ ^ +-----+ ^ +-----+
Jagang	0:41149573d577	63	* Channel B ^ \| ^ \| ^ \| ^ \| ^ \| \|
Jagang	0:41149573d577	64	* ------+ ^ +-----+ ^ +-----+ +--
Jagang	0:41149573d577	65	* ^ ^ ^ ^ ^
Jagang	0:41149573d577	66	* ^ ^ ^ ^ ^
Jagang	0:41149573d577	67	* Pulse count 0 1 2 3 4 5 ...
Jagang	0:41149573d577	68	*
Jagang	0:41149573d577	69	* This interface can also use X4 encoding which calculates the pulse count
Jagang	0:41149573d577	70	* based on reading the current state after each rising and falling edge of
Jagang	0:41149573d577	71	* either channel.
Jagang	0:41149573d577	72	*
Jagang	0:41149573d577	73	* +-----+ +-----+ +-----+
Jagang	0:41149573d577	74	* Channel A \| \| \| \| \| \|
Jagang	0:41149573d577	75	* ---+ +-----+ +-----+ +-----
Jagang	0:41149573d577	76	* ^ ^ ^ ^ ^
Jagang	0:41149573d577	77	* ^ +-----+ ^ +-----+ ^ +-----+
Jagang	0:41149573d577	78	* Channel B ^ \| ^ \| ^ \| ^ \| ^ \| \|
Jagang	0:41149573d577	79	* ------+ ^ +-----+ ^ +-----+ +--
Jagang	0:41149573d577	80	* ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
Jagang	0:41149573d577	81	* ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
Jagang	0:41149573d577	82	* Pulse count 0 1 2 3 4 5 6 7 8 9 ...
Jagang	0:41149573d577	83	*
Jagang	0:41149573d577	84	* It defaults
Jagang	0:41149573d577	85	*
Jagang	0:41149573d577	86	* An optional index channel can be used which determines when a full
Jagang	0:41149573d577	87	* revolution has occured.
Jagang	0:41149573d577	88	*
Jagang	0:41149573d577	89	* If a 4 pules per revolution encoder was used, with X4 encoding,
Jagang	0:41149573d577	90	* the following would be observed.
Jagang	0:41149573d577	91	*
Jagang	0:41149573d577	92	* +-----+ +-----+ +-----+
Jagang	0:41149573d577	93	* Channel A \| \| \| \| \| \|
Jagang	0:41149573d577	94	* ---+ +-----+ +-----+ +-----
Jagang	0:41149573d577	95	* ^ ^ ^ ^ ^
Jagang	0:41149573d577	96	* ^ +-----+ ^ +-----+ ^ +-----+
Jagang	0:41149573d577	97	* Channel B ^ \| ^ \| ^ \| ^ \| ^ \| \|
Jagang	0:41149573d577	98	* ------+ ^ +-----+ ^ +-----+ +--
Jagang	0:41149573d577	99	* ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
Jagang	0:41149573d577	100	* ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
Jagang	0:41149573d577	101	* ^ ^ ^ +--+ ^ ^ +--+ ^
Jagang	0:41149573d577	102	* ^ ^ ^ \| \| ^ ^ \| \| ^
Jagang	0:41149573d577	103	* Index ------------+ +--------+ +-----------
Jagang	0:41149573d577	104	* ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
Jagang	0:41149573d577	105	* Pulse count 0 1 2 3 4 5 6 7 8 9 ...
Jagang	0:41149573d577	106	* Rev. count 0 1 2
Jagang	0:41149573d577	107	*
Jagang	0:41149573d577	108	* Rotational position in degrees can be calculated by:
Jagang	0:41149573d577	109	*
Jagang	0:41149573d577	110	* (pulse count / X * N) * 360
Jagang	0:41149573d577	111	*
Jagang	0:41149573d577	112	* Where X is the encoding type [e.g. X4 encoding => X=4], and N is the number
Jagang	0:41149573d577	113	* of pulses per revolution.
Jagang	0:41149573d577	114	*
Jagang	0:41149573d577	115	* Linear position can be calculated by:
Jagang	0:41149573d577	116	*
Jagang	0:41149573d577	117	* (pulse count / X * N) * (1 / PPI)
Jagang	0:41149573d577	118	*
Jagang	0:41149573d577	119	* Where X is encoding type [e.g. X4 encoding => X=44], N is the number of
Jagang	0:41149573d577	120	* pulses per revolution, and PPI is pulses per inch, or the equivalent for
Jagang	0:41149573d577	121	* any other unit of displacement. PPI can be calculated by taking the
Jagang	0:41149573d577	122	* circumference of the wheel or encoder disk and dividing it by the number
Jagang	0:41149573d577	123	* of pulses per revolution.
Jagang	0:41149573d577	124	*/
Jagang	0:41149573d577	125
Jagang	0:41149573d577	126	#ifndef QEI_H
Jagang	0:41149573d577	127	#define QEI_H
Jagang	0:41149573d577	128
Jagang	0:41149573d577	129	/**
Jagang	0:41149573d577	130	* Includes
Jagang	0:41149573d577	131	*/
Jagang	0:41149573d577	132	#include "mbed.h"
Jagang	0:41149573d577	133
Jagang	0:41149573d577	134	/**
Jagang	0:41149573d577	135	* Defines
Jagang	0:41149573d577	136	*/
Jagang	0:41149573d577	137	#define PREV_MASK 0x1 //Mask for the previous state in determining direction
Jagang	0:41149573d577	138	//of rotation.
Jagang	0:41149573d577	139	#define CURR_MASK 0x2 //Mask for the current state in determining direction
Jagang	0:41149573d577	140	//of rotation.
Jagang	0:41149573d577	141	#define INVALID 0x3 //XORing two states where both bits have changed.
Jagang	0:41149573d577	142
Jagang	0:41149573d577	143	/**
Jagang	0:41149573d577	144	* Quadrature Encoder Interface.
Jagang	0:41149573d577	145	*/
Jagang	0:41149573d577	146	class QEI {
Jagang	0:41149573d577	147
Jagang	0:41149573d577	148	public:
Jagang	0:41149573d577	149
Jagang	0:41149573d577	150	typedef enum Encoding {
Jagang	0:41149573d577	151
Jagang	0:41149573d577	152	X2_ENCODING,
Jagang	0:41149573d577	153	X4_ENCODING
Jagang	0:41149573d577	154
Jagang	0:41149573d577	155	} Encoding;
Jagang	0:41149573d577	156
Jagang	0:41149573d577	157	/**
Jagang	0:41149573d577	158	* Constructor.
Jagang	0:41149573d577	159	*
Jagang	0:41149573d577	160	* Reads the current values on channel A and channel B to determine the
Jagang	0:41149573d577	161	* initial state.
Jagang	0:41149573d577	162	*
Jagang	0:41149573d577	163	* Attaches the encode function to the rise/fall interrupt edges of
Jagang	0:41149573d577	164	* channels A and B to perform X4 encoding.
Jagang	0:41149573d577	165	*
Jagang	0:41149573d577	166	* Attaches the index function to the rise interrupt edge of channel index
Jagang	0:41149573d577	167	* (if it is used) to count revolutions.
Jagang	0:41149573d577	168	*
Jagang	0:41149573d577	169	* @param channelA mbed pin for channel A input.
Jagang	0:41149573d577	170	* @param channelB mbed pin for channel B input.
Jagang	0:41149573d577	171	* @param index mbed pin for optional index channel input,
Jagang	0:41149573d577	172	* (pass NC if not needed).
Jagang	0:41149573d577	173	* @param pulsesPerRev Number of pulses in one revolution.
Jagang	0:41149573d577	174	* @param encoding The encoding to use. Uses X2 encoding by default. X2
Jagang	0:41149573d577	175	* encoding uses interrupts on the rising and falling edges
Jagang	0:41149573d577	176	* of only channel A where as X4 uses them on both
Jagang	0:41149573d577	177	* channels.
Jagang	0:41149573d577	178	*/
Jagang	0:41149573d577	179	QEI(PinName channelA, PinName channelB, PinName index, int pulsesPerRev, Encoding encoding = X2_ENCODING);
Jagang	0:41149573d577	180
Jagang	0:41149573d577	181	/**
Jagang	0:41149573d577	182	* Reset the encoder.
Jagang	0:41149573d577	183	*
Jagang	0:41149573d577	184	* Sets the pulses and revolutions count to zero.
Jagang	0:41149573d577	185	*/
Jagang	0:41149573d577	186	void reset(void);
Jagang	0:41149573d577	187
Jagang	0:41149573d577	188	/**
Jagang	0:41149573d577	189	* Read the state of the encoder.
Jagang	0:41149573d577	190	*
Jagang	0:41149573d577	191	* @return The current state of the encoder as a 2-bit number, where:
Jagang	0:41149573d577	192	* bit 1 = The reading from channel B
Jagang	0:41149573d577	193	* bit 2 = The reading from channel A
Jagang	0:41149573d577	194	*/
Jagang	0:41149573d577	195	int getCurrentState(void);
Jagang	0:41149573d577	196
Jagang	0:41149573d577	197	/**
Jagang	0:41149573d577	198	* Read the number of pulses recorded by the encoder.
Jagang	0:41149573d577	199	*
Jagang	0:41149573d577	200	* @return Number of pulses which have occured.
Jagang	0:41149573d577	201	*/
Jagang	0:41149573d577	202	int getPulses(void);
Jagang	0:41149573d577	203
Jagang	0:41149573d577	204	/**
Jagang	0:41149573d577	205	* Read the number of revolutions recorded by the encoder on the index channel.
Jagang	0:41149573d577	206	*
Jagang	0:41149573d577	207	* @return Number of revolutions which have occured on the index channel.
Jagang	0:41149573d577	208	*/
Jagang	0:41149573d577	209	int getRevolutions(void);
Jagang	0:41149573d577	210
Jagang	0:41149573d577	211
Jagang	0:41149573d577	212
Jagang	0:41149573d577	213	/**
Jagang	0:41149573d577	214	* Update the pulse count.
Jagang	0:41149573d577	215	*
Jagang	0:41149573d577	216	* Called on every rising/falling edge of channels A/B.
Jagang	0:41149573d577	217	*
Jagang	0:41149573d577	218	* Reads the state of the channels and determines whether a pulse forward
Jagang	0:41149573d577	219	* or backward has occured, updating the count appropriately.
Jagang	0:41149573d577	220	*/
Jagang	0:41149573d577	221	void encode(void);
Jagang	0:41149573d577	222
Jagang	0:41149573d577	223	int getPulsesPerRev() {return pulsesPerRev_;}
Jagang	0:41149573d577	224	private:
Jagang	0:41149573d577	225	/**
Jagang	0:41149573d577	226	* Called on every rising edge of channel index to update revolution
Jagang	0:41149573d577	227	* count by one.
Jagang	0:41149573d577	228	*/
Jagang	0:41149573d577	229	void index(void);
Jagang	0:41149573d577	230
Jagang	0:41149573d577	231	Encoding encoding_;
Jagang	0:41149573d577	232
Jagang	0:41149573d577	233	InterruptIn channelA_;
Jagang	0:41149573d577	234	InterruptIn channelB_;
Jagang	0:41149573d577	235	InterruptIn index_;
Jagang	0:41149573d577	236
Jagang	0:41149573d577	237	int pulsesPerRev_;
Jagang	0:41149573d577	238	int prevState_;
Jagang	0:41149573d577	239	int currState_;
Jagang	0:41149573d577	240
Jagang	0:41149573d577	241	volatile int pulses_;
Jagang	0:41149573d577	242	volatile int revolutions_;
Jagang	0:41149573d577	243
Jagang	0:41149573d577	244	};
Jagang	0:41149573d577	245
Jagang	0:41149573d577	246	#endif /* QEI_H */