Component: Joystick (Sparkfun Quiic) (Analog Input)

Author	Matrix TSL
Version	1.0
Category	Analog Input

Joystick (Sparkfun Quiic) component

An XY sprung joystick with click switch allowing for easy user input control. Connected using I2C bus.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

There is a detailed walk through of the scenario detailed at the link below to go with this component.

Traffic Light Scenario

Downloadable macro reference

	ChangeI2CAddress
Allows the I2C Device address to be changed which in turn allows more then one RFID reader to sit on the same physical I2C bus. Returns 1 if succesful.
- BYTE	NewAddress
Range: 8 to 119 or 0x08 - 0x77
- BOOL	Return

	CheckButton
Checks to see if the button has been pressed since the last read of CheckButton or ReadButton.
- BOOL	Return

	ReadAxis
Reads a single axis of the joystick and returns as a signed integer value.
- BYTE	Axis
Range 0-1 Where 0=X, 1=Y
- BOOL	Type
0 = Signed (-512 to 511), 1 = Unsigned (0 to 1023)
- INT	Return

	ReadButton
Checks to see if the button is currently pressed
- BOOL	Return

	Initialise
Initialises the I2C bus ready for communications with the module.
- VOID	Return

Property reference

	Properties
	Return To Center
Decides if the joystick automatically returns to the center position when released. Yes: The joystick will return to the center when released. No: The joystick will remain in the current position when released.
	X Min
	X Max
	Y Min
	Y Max
	Device Address
External device address used to communicate with the module. Default 32 or 0x20
	Connections
	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Simulations
	Simulate Comms
Controls if we are using the panel simulation or simulating the I2C calls for use with an I2C injector.
	Scope Traces
Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.
	Console Data
Selects if the console data is automatically generated or not
	API
Specifies the injector component on the panel to interact with to provide comms simulation.