Difference between revisions of "Component: Joystick (Sparkfun Quiic) (Analog Input)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/ | + | Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Sparkfun_Quiic_Joystick.fcfx FC_Comp_Source_Sparkfun_Quiic_Joystick.fcfx] |
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 38: | Line 40: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 110: | Line 114: | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| Line 182: | Line 158: | ||
|- | |- | ||
| colspan="2" | 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. | | colspan="2" | 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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| width="90%" | Device Address | | width="90%" | Device Address | ||
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | External device address used to communicate with the module. Default 32 or 0x20 |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| Line 244: | Line 177: | ||
|- | |- | ||
| colspan="2" | Baud rate option selector | | colspan="2" | Baud rate option selector | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| + | | width="90%" | Baud Rate | ||
| + | |- | ||
| + | | colspan="2" | Baud rate to be used | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| Line 249: | Line 187: | ||
|- | |- | ||
| colspan="2" | Pin used for SDA (data signal) | | colspan="2" | Pin used for SDA (data signal) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| Line 259: | Line 192: | ||
|- | |- | ||
| colspan="2" | Pin used for SCL (clock signal) | | colspan="2" | Pin used for SCL (clock signal) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| Line 277: | Line 205: | ||
| width="90%" | Simulate Comms | | width="90%" | Simulate Comms | ||
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Controls if we are using the panel simulation or simulating the I2C calls for use with an I2C injector. |
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| Line 292: | Line 220: | ||
| width="90%" | API | | width="90%" | API | ||
|- | |- | ||
| − | | colspan="2" | Specifies the | + | | colspan="2" | Specifies the injector component on the panel to interact with to provide comms simulation. |
|} | |} | ||
Revision as of 14:42, 16 January 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Analog Input |
Contents
Joystick (Sparkfun Quiic) component
An XY sprung joystick with click switch allowing for easy user input control. Connected using I2C bus.
Component Source Code
Please click here for the component source code: FC_Comp_Source_Sparkfun_Quiic_Joystick.fcfx
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.
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. | |
|
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. | |
|
|
Simulation |
|
|
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. | |
