Component: Joystick (Sparkfun Quiic) (Analog Input): Difference between revisions
Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray..." |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (24 intermediate revisions by 3 users not shown) | |||
| Line 5: | Line 5: | ||
|- | |- | ||
| width="20%" style="color:gray;" | Version | | width="20%" style="color:gray;" | Version | ||
| | | 9.0 | ||
|- | |- | ||
| width="20%" style="color:gray;" | Category | | width="20%" style="color:gray;" | Category | ||
| Line 16: | Line 16: | ||
==Detailed description== | ==Detailed description== | ||
''No detailed description exists yet for this component'' | ''No detailed description exists yet for this component'' | ||
| Line 22: | Line 48: | ||
{| class="wikitable | |||
''<span style="color:red;">No additional examples</span>'' | |||
==Macro reference== | |||
===ChangeI2CAddress=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ChangeI2CAddress''' | ||
|- | |- | ||
| colspan="2" | 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. | | colspan="2" | 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. | ||
| Line 41: | Line 75: | ||
| colspan="2" | Range: 8 to 119 or 0x08 - 0x77 | | colspan="2" | Range: 8 to 119 or 0x08 - 0x77 | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===CheckButton=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CheckButton''' | ||
|- | |- | ||
| colspan="2" | Checks to see if the button has been pressed since the last read of CheckButton or ReadButton. | | colspan="2" | Checks to see if the button has been pressed since the last read of CheckButton or ReadButton. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===Initialise=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" style=" | | width="90%" class="mtx-class-macrohead" | '''Initialise''' | ||
|- | |||
| colspan="2" | Initialises the I2C bus ready for communications with the module. | |||
|- | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
===ReadAxis=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''ReadAxis''' | |||
|- | |- | ||
| colspan="2" | Reads a single axis of the joystick and returns as a signed integer value. | | colspan="2" | Reads a single axis of the joystick and returns as a signed integer value. | ||
| Line 72: | Line 122: | ||
| colspan="2" | Range 0-1 Where 0=X, 1=Y | | colspan="2" | Range 0-1 Where 0=X, 1=Y | ||
|- | |- | ||
| width="10%" align="center" | [[File:]] - | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| width="90%" | Type | | width="90%" | Type | ||
|- | |- | ||
| colspan="2" | 0 = Signed (-512 to 511), 1 = Unsigned (0 to 1023) | | colspan="2" | 0 = Signed (-512 to 511), 1 = Unsigned (0 to 1023) | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | | 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'' | ||
|} | |} | ||
{| class="wikitable | ===ReadButton=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadButton''' | ||
|- | |- | ||
| colspan="2" | Checks to see if the button is currently pressed | | colspan="2" | Checks to see if the button is currently pressed | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| Line 122: | 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]] | ||
| Line 148: | Line 164: | ||
| colspan="2" | External device address used to communicate with the module. Default 32 or 0x20 | | colspan="2" | External device address used to communicate with the module. Default 32 or 0x20 | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Connections | ||
|- | |- | ||
|- | |- | ||
| Line 182: | Line 198: | ||
| colspan="2" | 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. | | colspan="2" | 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. | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Simulation | ||
|- | |- | ||
|- | |- | ||
| Line 206: | Line 222: | ||
| colspan="2" | Specifies the injector component on the panel to interact with to provide comms simulation. | | colspan="2" | Specifies the injector component on the panel to interact with to provide comms simulation. | ||
|} | |} | ||
==Component Source Code== | |||
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Sparkfun_Quiic_Joystick.fcfx FC_Comp_Source_Sparkfun_Quiic_Joystick.fcfx] | |||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Sparkfun_Quiic_Joystick.fcfx FC_Comp_Source_Sparkfun_Quiic_Joystick.fcfx] | |||
Latest revision as of 14:36, 13 July 2026
| Author | Matrix TSL |
| Version | 9.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.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
ChangeI2CAddress
|
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
|
|
CheckButton |
| Checks to see if the button has been pressed since the last read of CheckButton or ReadButton. | |
| - BOOL
|
Return |
Initialise
|
|
Initialise |
| Initialises the I2C bus ready for communications with the module. | |
 - VOID
|
Return |
ReadAxis
|
|
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
|
|
ReadButton |
| Checks to see if the button is currently pressed | |
| - BOOL
|
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. | |
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Sparkfun_Quiic_Joystick.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Sparkfun_Quiic_Joystick.fcfx