Difference between revisions of "Component: Keypad (4x4) (Keypad)"
From Flowcode Help
Jump to navigationJump to search| (8 intermediate revisions by the same user not shown) | |||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here | + | 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] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 28: | Line 40: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 37: | Line 59: | ||
| − | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Macro reference== | ||
| + | |||
| + | ===GetAscii=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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 52: | Line 85: | ||
| + | ===GetIndex=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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 65: | Line 99: | ||
| + | ===GetNumber=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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'' | ||
|} | |} | ||
| + | ===GetString=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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'' | ||
|} | |} | ||
| + | ===WaitPressed=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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 104: | Line 141: | ||
| + | ===WaitReleased=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 115: | Line 153: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | |||
| − | |||
Latest revision as of 13:11, 7 February 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Keypad |
Contents
Keypad component
Preset keypad based around the 4 * 4 unit.
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
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. | |
