Joystick

Rick Waldron edited this page May 13, 2016 · 19 revisions

The Joystick class constructs objects that represent a single Joystick sensor attached to the physical board.

This list will continue to be updated as more Joystick devices are confirmed.

Parameters

  • General Options

    Property Type Value/Description Default Required
    pins Array of Pins ["A*", ...]. Analog pins connected to X and Y yes
    invert Boolean true, false. Invert both axes false no
    invertX Boolean true, false. Invert the X axis false no
    invertY Boolean true, false. Invert the Y axis false no

Shape

Property Name Description Read Only
id A user definable id value. Defaults to a generated uid No
x -1, 1. Yes
y -1, 1. Yes

Component Initialization

Analog

new five.Joystick({
  // [ x, y ]
  pins: ["A0", "A1"]
});

Joystick

Adafruit Joystick

SparkFun Joystick

Sparkfun Shield

new five.Joystick({
  pins: ["A0", "A1"], 
  invertY: true
});

SparkFun JoyStick Shield

Esplora

new five.Joystick({
  controller: "ESPLORA"
});

Esplora

Axis Inversion

Default
var joy = new Joystick({ 
  pins: ["A0", "A1"], 
});

Produces the following default axes:

    -1
-1   *   1
     1      
Invert Y
var joy = new Joystick({ 
  pins: ["A0", "A1"], 
  invertY: true 
});

Produces an inverted Y axis, with a default X axis:

     1
-1   *   1
    -1      
Invert X
var joy = new Joystick({ 
  pins: ["A0", "A1"], 
  invertX: true 
});

Produces an inverted X axis, with a default Y axis:

   -1
1   *  -1
    1      
Invert Both
var joy = new Joystick({ 
  pins: ["A0", "A1"], 
  invert: true 
});

Produces an both inverted X and Y axes:

    1
1   *  -1
   -1      

API

There are no special API functions for this class.

Events

  • change The "change" event is emitted whenever the value of an axis changes.

  • data The "data" event is fired as frequently as the user defined freq will allow in milliseconds.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.