Qwiic Joystick Hookup Guide

Arduino Library

The easiest way to install the Arduino library is by searching SparkFun Qwiic Joystick inside the Arduino library manager. To manually install, head on over to the GitHub Page or feel free to download the library here!

Library Functions

The Arduino library is commented and the functions should be self-explanatory. However, below is a detailed list of the available library functions.

.begin() or .begin(Wire, deviceAddress)
Creates a connection to an I²C device over the I²C bus using the default or specified I²C address.

.isConnected()
Tries to connect to the device at the I²C address stored in the library.

.setI2CAddress(newAddress)
Changes the I²C address to newAddress. Once changed, the new I²C address is saved in the EEPROM of the Qwiic Joystick. Reconnects to device using new I²C address. (The new address is printed out in the Serial Monitor.)

.getHorizontal()
Returns the ADC value of the joystick horizontal position.

.getVertical()
Returns the ADC value of the joystick vertical position.

.getButton()
Returns the current button state (clears check button indicator - see below).

.checkButton()
Indicates if the button was pressed between reads of the button state or calls of this function. The register for this indicator is then cleared.

.getVersion()
Returns a string of the firmware version number.

Examples

There are four examples in the Qwiic Joystick Arduino Library to get you started with using Qwiic Joystick. These example files are named with self-explanatory titles, but in case you want more information, see the descriptions below.

• Example1_Basic_Readings

  This example connects to the Qwiic Joystick using the default I²C address saved in the library. The sketch looks at the registers for the current joystick position and button state. The example then prints out those values over the Serial Monitor.

• Example2_I2C_Address_and_Firmware

  This example connects to the Qwiic Joystick using the default I²C address set in the sketch and then prints out the I²C address and firmware version over the Serial Monitor. The sketch then, takes an input from the Serial Monitor to change the I²C address using a decimal value (DEC). Once the I²C address is changed, it is stored in the EEPROM of the Qwiic Joystick. After, the sketch connects to the joystick using the new I²C address and reads the registers for the firmware version again. The example then prints out those values over the Serial Monitor again.

• Example3_I2C_Scanner

  This example is from the I²C scanner example from the Arduino Playground webpage. The sketch scans for devices on the I²C bus and reports them on the Serial Monitor. This is useful for users who have forgotten the changed I²C address of their boards.

• Example4_Joystic_Serial_Output

  This example shows a basic example of how to begin to use the Qwiic Joystick as an HID. The example sketch takes values of the joystick and converts it to directional printouts on the Serial Monitor.