Craig Evans / Joystick

Analog joystick library

Dependents:   GameProject_Prototype Joystick lcd205 Joystick205 ... more

Joystick.h@0:649b59b2fb26, 2017-02-07 (annotated)

Committer:
eencae
Date:
Tue Feb 07 13:01:48 2017 +0000
Revision:
0:649b59b2fb26
Updated docs

Who changed what in which revision?

UserRevisionLine numberNew contents of line
eencae 0:649b59b2fb26 1 #ifndef JOYSTICK_H
eencae 0:649b59b2fb26 2 #define JOYSTICK_H
eencae 0:649b59b2fb26 3
eencae 0:649b59b2fb26 4 #include "mbed.h"
eencae 0:649b59b2fb26 5
eencae 0:649b59b2fb26 6 // this value can be tuned to alter tolerance of joystick movement
eencae 0:649b59b2fb26 7 #define TOL 0.1f
eencae 0:649b59b2fb26 8 #define RAD2DEG 57.2957795131f
eencae 0:649b59b2fb26 9
eencae 0:649b59b2fb26 10 enum Direction {
eencae 0:649b59b2fb26 11 CENTRE, // 0
eencae 0:649b59b2fb26 12 N, // 1
eencae 0:649b59b2fb26 13 NE, // 2
eencae 0:649b59b2fb26 14 E, // 3
eencae 0:649b59b2fb26 15 SE, // 4
eencae 0:649b59b2fb26 16 S, // 5
eencae 0:649b59b2fb26 17 SW, // 6
eencae 0:649b59b2fb26 18 W, // 7
eencae 0:649b59b2fb26 19 NW // 8
eencae 0:649b59b2fb26 20 };
eencae 0:649b59b2fb26 21
eencae 0:649b59b2fb26 22 struct Vector2D {
eencae 0:649b59b2fb26 23 float x;
eencae 0:649b59b2fb26 24 float y;
eencae 0:649b59b2fb26 25 };
eencae 0:649b59b2fb26 26
eencae 0:649b59b2fb26 27 struct Polar {
eencae 0:649b59b2fb26 28 float mag;
eencae 0:649b59b2fb26 29 float angle;
eencae 0:649b59b2fb26 30 };
eencae 0:649b59b2fb26 31
eencae 0:649b59b2fb26 32 /** Joystick Class
eencae 0:649b59b2fb26 33 @author Dr Craig A. Evans, University of Leeds
eencae 0:649b59b2fb26 34 @brief Library for interfacing with analogue joystick
eencae 0:649b59b2fb26 35
eencae 0:649b59b2fb26 36 Example:
eencae 0:649b59b2fb26 37
eencae 0:649b59b2fb26 38 @code
eencae 0:649b59b2fb26 39
eencae 0:649b59b2fb26 40 #include "mbed.h"
eencae 0:649b59b2fb26 41 #include "Joystick.h"
eencae 0:649b59b2fb26 42
eencae 0:649b59b2fb26 43 // y x button
eencae 0:649b59b2fb26 44 Joystick joystick(PTB10,PTB11,PTC16);
eencae 0:649b59b2fb26 45
eencae 0:649b59b2fb26 46 int main() {
eencae 0:649b59b2fb26 47
eencae 0:649b59b2fb26 48 joystick.init();
eencae 0:649b59b2fb26 49
eencae 0:649b59b2fb26 50 while(1) {
eencae 0:649b59b2fb26 51
eencae 0:649b59b2fb26 52 Vector2D coord = joystick.get_coord();
eencae 0:649b59b2fb26 53 printf("Coord = %f,%f\n",coord.x,coord.y);
eencae 0:649b59b2fb26 54
eencae 0:649b59b2fb26 55 Vector2D mapped_coord = joystick.get_mapped_coord();
eencae 0:649b59b2fb26 56 printf("Mapped coord = %f,%f\n",mapped_coord.x,mapped_coord.y);
eencae 0:649b59b2fb26 57
eencae 0:649b59b2fb26 58 float mag = joystick.get_mag();
eencae 0:649b59b2fb26 59 float angle = joystick.get_angle();
eencae 0:649b59b2fb26 60 printf("Mag = %f Angle = %f\n",mag,angle);
eencae 0:649b59b2fb26 61
eencae 0:649b59b2fb26 62 Direction d = joystick.get_direction();
eencae 0:649b59b2fb26 63 printf("Direction = %i\n",d);
eencae 0:649b59b2fb26 64
eencae 0:649b59b2fb26 65 if (joystick.button_pressed() ) {
eencae 0:649b59b2fb26 66 printf("Button Pressed\n");
eencae 0:649b59b2fb26 67 }
eencae 0:649b59b2fb26 68
eencae 0:649b59b2fb26 69 wait(0.5);
eencae 0:649b59b2fb26 70 }
eencae 0:649b59b2fb26 71
eencae 0:649b59b2fb26 72
eencae 0:649b59b2fb26 73 }
eencae 0:649b59b2fb26 74
eencae 0:649b59b2fb26 75 * @endcode
eencae 0:649b59b2fb26 76 */
eencae 0:649b59b2fb26 77 class Joystick
eencae 0:649b59b2fb26 78 {
eencae 0:649b59b2fb26 79 public:
eencae 0:649b59b2fb26 80
eencae 0:649b59b2fb26 81 // y-pot x-pot button
eencae 0:649b59b2fb26 82 Joystick(PinName vertPin,PinName horizPin,PinName clickPin);
eencae 0:649b59b2fb26 83
eencae 0:649b59b2fb26 84 void init(); // needs to be called at start with joystick centred
eencae 0:649b59b2fb26 85 float get_mag(); // polar
eencae 0:649b59b2fb26 86 float get_angle(); // polar
eencae 0:649b59b2fb26 87 Vector2D get_coord(); // cartesian co-ordinates x,y
eencae 0:649b59b2fb26 88 Vector2D get_mapped_coord(); // x,y mapped to circle
eencae 0:649b59b2fb26 89 Direction get_direction(); // N,NE,E,SE etc.
eencae 0:649b59b2fb26 90 Polar get_polar(); // mag and angle in struct form
eencae 0:649b59b2fb26 91 bool button_pressed(); // read button flag set in ISR when button pressed
eencae 0:649b59b2fb26 92
eencae 0:649b59b2fb26 93 private:
eencae 0:649b59b2fb26 94
eencae 0:649b59b2fb26 95 AnalogIn *vert;
eencae 0:649b59b2fb26 96 AnalogIn *horiz;
eencae 0:649b59b2fb26 97 InterruptIn *click;
eencae 0:649b59b2fb26 98
eencae 0:649b59b2fb26 99 int _click_flag; // flag set in ISR
eencae 0:649b59b2fb26 100 void click_isr(); // ISR on button press
eencae 0:649b59b2fb26 101
eencae 0:649b59b2fb26 102 // centred x,y values
eencae 0:649b59b2fb26 103 float _x0;
eencae 0:649b59b2fb26 104 float _y0;
eencae 0:649b59b2fb26 105
eencae 0:649b59b2fb26 106 };
eencae 0:649b59b2fb26 107
eencae 0:649b59b2fb26 108 #endif