com.raspoid.additionalcomponents

Class Joystick

java.lang.Object

com.raspoid.AnalogComponent

com.raspoid.additionalcomponents.Joystick

All Implemented Interfaces:

Component

public class Joystick
extends AnalogComponent

Implementation of a Joystick PS2 module.

Example of module: http://www.sunfounder.com/joystick-ps2-module.html

To decode the signals received from this joystick module, we need to use an ADC (Analog to Digital Converter). We then decode the x, y and bt signals from analogic to digital.

See Also:

Example datasheet: Joystick

Example of use: {@link JoystickExample}

Field Summary

Fields inherited from class com.raspoid.AnalogComponent

adc

Constructor Summary

Constructors

Constructor and Description
Joystick(ADC adc, ADCChannel xChannel, ADCChannel yChannel, ADCChannel btChannel) Constructor for a joystick using a specifc ADC instance, and specific channels on this ADC for the x, y and bt variations of the joystick.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPosition() Returns the main current position of the joystick among (by priority):
int[]	getRawData() Returns an array containing raw digital outputs respectively for variations on the X axis variations on the Y axis variations on the push button
int[]	getXYPosition() Returns the (x, y) position of the joystick, or (-1,-1) if button pressed.

Methods inherited from class com.raspoid.AnalogComponent

getADC, getType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Joystick

public Joystick(ADC adc,
                ADCChannel xChannel,
                ADCChannel yChannel,
                ADCChannel btChannel)

Constructor for a joystick using a specifc ADC instance, and specific channels on this ADC for the x, y and bt variations of the joystick.

Parameters:

adc - the ADC to use to decode analogic signals from the joystick.

xChannel - the channel on the ADC used to read variations on the x axis of the joystick.

yChannel - the channel on the ADC used to read variations on the y axis of the joystick.

btChannel - the channel on the ADC used to read variations on the push button of the joystick.

Method Detail

getPosition

public java.lang.String getPosition()

Returns the main current position of the joystick among (by priority):

  1. press-down
  2. up/down
  4. left/right
  5. home
 

Note: "by priority" means "if 'home' and 'press-down', 'press-down' returned".

Returns:

the main current position of the joystick

getXYPosition

public int[] getXYPosition()

Returns the (x, y) position of the joystick, or (-1,-1) if button pressed.

x and y values are between 0 and 255.

Returns:

the (x,y) position of the joystick (with x and y in the 0..255 range). (-1,-1) if the button is pressed.

getRawData

public int[] getRawData()

Returns an array containing raw digital outputs respectively for

• variations on the X axis
• variations on the Y axis
• variations on the push button

Returns:

an array containing raw digital output vaules for [x axis, y axis, push button].