Skip to content
This repository has been archived by the owner on Dec 8, 2023. It is now read-only.

Latest commit

 

History

History
56 lines (38 loc) · 1.95 KB

README.md

File metadata and controls

56 lines (38 loc) · 1.95 KB
Raw

KY-023

Class for using KY-023 Joystick module with Arduino

KY-023

Description

Allows reading X and Y values from joystick connected to analog inputs. Includes following freatures:

  • finds stable reading of joy's neutral position (fixes issue with reading wobbling when joy is not being touched)
  • projects unequal axes to ideal axes (fixes issue with with reading not showing center when joy is in neutral position)
  • outputs 0-255 value to fit in byte (for easier transmission via eg. nRF24L01+) instead of joy's actual 0-1023; you can change XY_MAX_OUT to output required range
  • allows reversing axis output (0..255 -> 255..0)
  • defines deadzone where near center reading will output exactly central position

Dependencies

  • <Arduino.h>

Installing

  • Copy Joy.cpp file to your project directory
  • Add #include "Joy.cpp" line on top of your Arduino project

Executing program

  • Create instance of Joy class in global context (outside setup() and loop() functions) eg.
\\ Joy(byte x_pin, byte y_pin, byte button_pin, byte deadzone_radius)
Joy joy(A0, A1, 7, 3);
  • Add joy.setup() within Arduino main setup() section
  • In Arduino loop() section you can now read axis position
joy.readJoyAxisAsByte(joy.X_AXIS)
joy.readJoyAxisAsByte(joy.Y_AXIS)
  • When Arduino starts leave joy in neutral position for 1 second so it can find stable neutral read
  • If needed reverse axis by using joy.reverse(joy.readJoyAxisAsByte(joy.X_AXIS))

Help

Any issues, questions and improvement ideas can be raised via GitHub.

Known issues

  • Button pin is not implemented at the moment and you can use dummy pin number to create instance of a class
  • Due to limited math precision output may differ by 1 from actual read which shouldn't be a problem for such low accuracy joystick

Acknowledgments

Thanks to the guys from freenode IRC channel ##C++-general, especially:

  • Alipha
  • cbreak