Component: Keypad (4x4) (Keypad): Difference between revisions
No edit summary |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 15: | Line 15: | ||
Preset keypad based around the 4 * 4 unit. | Preset keypad based around the 4 * 4 unit. | ||
== | ==Detailed description== | ||
| Line 30: | Line 34: | ||
==Examples== | ==Examples== | ||
| Line 39: | Line 51: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
==Macro reference== | ==Macro reference== | ||
{| class="wikitable | ===GetAscii=== | ||
{| 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" | '''GetAscii''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. | ||
|- | |- | ||
|- | |- | ||
| Line 56: | Line 79: | ||
{| class="wikitable | ===GetIndex=== | ||
{| 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" | '''GetIndex''' | ||
|- | |- | ||
| colspan="2" | Gets the | | colspan="2" | Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. | ||
|- | |- | ||
|- | |- | ||
| Line 69: | Line 93: | ||
{| class="wikitable | ===GetNumber=== | ||
{| 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" | '''GetNumber''' | ||
|- | |- | ||
| colspan="2" | Gets the | | colspan="2" | Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===GetString=== | ||
{| 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" | '''GetString''' | ||
|- | |- | ||
| colspan="2" | Gets the | | colspan="2" | Gets the ASCII value for the current keypress and returns in the form of a string. If no key pressed then the macro returns the value 255. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===WaitPressed=== | ||
{| 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" | '''WaitPressed''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Blocking call that waits for one of the keys on the keypad to be pressed. The index of the key that was pressed is passed back to the user. | ||
|- | |- | ||
|- | |- | ||
| Line 108: | Line 135: | ||
{| class="wikitable | ===WaitReleased=== | ||
{| 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" | '''WaitReleased''' | ||
|- | |- | ||
| colspan="2" | Blocking call that waits for the keys on the keypad to be released. If no key is pressed then the function will return immediatley. | | colspan="2" | Blocking call that waits for the keys on the keypad to be released. If no key is pressed then the function will return immediatley. | ||
| Line 119: | Line 147: | ||
| 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''' | ||
|- | |- | ||
|- | |- | ||
| 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 145: | Line 171: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| 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" | Appearance | ||
|- | |- | ||
|- | |- | ||
| Line 154: | Line 180: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| 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" | Button 1 | ||
|- | |- | ||
|- | |- | ||
| Line 168: | Line 194: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 2 | ||
|- | |- | ||
|- | |- | ||
| Line 182: | Line 208: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 3 | ||
|- | |- | ||
|- | |- | ||
| Line 196: | Line 222: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 4 | ||
|- | |- | ||
|- | |- | ||
| Line 210: | Line 236: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 5 | ||
|- | |- | ||
|- | |- | ||
| Line 224: | Line 250: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 6 | ||
|- | |- | ||
|- | |- | ||
| Line 238: | Line 264: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 7 | ||
|- | |- | ||
|- | |- | ||
| Line 252: | Line 278: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 8 | ||
|- | |- | ||
|- | |- | ||
| Line 266: | Line 292: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 9 | ||
|- | |- | ||
|- | |- | ||
| Line 280: | Line 306: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 10 | ||
|- | |- | ||
|- | |- | ||
| Line 294: | Line 320: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 11 | ||
|- | |- | ||
|- | |- | ||
| Line 308: | Line 334: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 12 | ||
|- | |- | ||
|- | |- | ||
| Line 322: | Line 348: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 13 | ||
|- | |- | ||
|- | |- | ||
| Line 336: | Line 362: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 14 | ||
|- | |- | ||
|- | |- | ||
| Line 350: | Line 376: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 15 | ||
|- | |- | ||
|- | |- | ||
| Line 364: | Line 390: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|- | |- | ||
| 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" | Button 16 | ||
|- | |- | ||
|- | |- | ||
| Line 378: | Line 404: | ||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | | colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | ||
|} | |} | ||
==Component Source Code== | |||
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Keypad_4x4.fcfx FC_Comp_Source_Keypad_4x4.fcfx] | |||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Keypad_4x4.fcfx FC_Comp_Source_Keypad_4x4.fcfx] | |||
Latest revision as of 14:36, 13 July 2026
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Keypad |
Keypad component
Preset keypad based around the 4 * 4 unit.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
GetAscii
|
GetAscii |
| Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. | |
 - BYTE
|
Return |
GetIndex
|
|
GetIndex |
| Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. | |
| - BYTE
|
Return |
GetNumber
|
|
GetNumber |
| Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. | |
| - BYTE
|
Return |
GetString
|
|
GetString |
| Gets the ASCII value for the current keypress and returns in the form of a string. If no key pressed then the macro returns the value 255. | |
 - STRING
|
Return |
WaitPressed
|
|
WaitPressed |
| Blocking call that waits for one of the keys on the keypad to be pressed. The index of the key that was pressed is passed back to the user. | |
| - BYTE
|
Return |
WaitReleased
|
|
WaitReleased |
| Blocking call that waits for the keys on the keypad to be released. If no key is pressed then the function will return immediatley. | |
 - VOID
|
Return |
Property reference
|
Properties |
|
Connections |
|
Output Mode |
|
Port |
|
|
Appearance |
|
Backplate Colour |
|
|
Button 1 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 2 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 3 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 4 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 5 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 6 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 7 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 8 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 9 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 10 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 11 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 12 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 13 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 14 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 15 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
|
|
Button 16 |
|
|
Key colour |
| Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |
|
|
Label colour |
| Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Keypad_4x4.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Keypad_4x4.fcfx