Difference between revisions of "Component: Keypad (4x4) (Keypad)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Keypad_4x4.fcfx FC_Comp_Source_Keypad_4x4.fcfx]
+
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]
 
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 36: Line 38:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 52: Line 56:
  
 
==Macro reference==
 
==Macro reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WaitPressed'''
 +
|-
 +
| 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. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAscii'''
 +
|-
 +
| colspan="2" | Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetString'''
 +
|-
 +
| 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-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetNumber'''
 +
|-
 +
| 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-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIndex'''
 +
|-
 +
| colspan="2" | Gets the index 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-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
 +
 +
==Property reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Output Mode
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-19-icon.png]]
 +
| width="90%" | Port
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Backplate Colour
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 1
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 2
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 3
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 4
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 5
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 6
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 7
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 8
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 9
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 10
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 11
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 12
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 13
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 14
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 15
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 16
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Key colour
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label colour
 +
|-
 +
| 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. 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 09:57, 27 January 2023

Author Matrix TSL
Version 1.0
Category Keypad


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

Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetAscii
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetNumber
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetIndex
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Output Mode
 
Fc9-type-19-icon.png Port
 
Fc9-conn-icon.png Appearance
Fc9-type-1-icon.png Backplate Colour
 
Fc9-conn-icon.png Button 1
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 2
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 3
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 4
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 5
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 6
Fc9-type-1-icon.png 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. 
Fc9-type-2-icon.png 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. 
Fc9-conn-icon.png Button 7
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 8
Fc9-type-1-icon.png 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. 
Fc9-type-2-icon.png 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. 
Fc9-conn-icon.png Button 9
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 10
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 11
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 12
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 13
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 14
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 15
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 16
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 

==Macro reference==

Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetAscii
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetNumber
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetIndex
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Output Mode
 
Fc9-type-19-icon.png Port
 
Fc9-conn-icon.png Appearance
Fc9-type-1-icon.png Backplate Colour
 
Fc9-conn-icon.png Button 1
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 2
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 3
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 4
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 5
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 6
Fc9-type-1-icon.png 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. 
Fc9-type-2-icon.png 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. 
Fc9-conn-icon.png Button 7
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 8
Fc9-type-1-icon.png 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. 
Fc9-type-2-icon.png 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. 
Fc9-conn-icon.png Button 9
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 10
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 11
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 12
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 13
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 14
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 15
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 16
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 

==Macro reference==

Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetAscii
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetNumber
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetIndex
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Output Mode
 
Fc9-type-19-icon.png Port
 
Fc9-conn-icon.png Appearance
Fc9-type-1-icon.png Backplate Colour
 
Fc9-conn-icon.png Button 1
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 2
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 3
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 4
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 5
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 6
Fc9-type-1-icon.png 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. 
Fc9-type-2-icon.png 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. 
Fc9-conn-icon.png Button 7
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 8
Fc9-type-1-icon.png 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. 
Fc9-type-2-icon.png 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. 
Fc9-conn-icon.png Button 9
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 10
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 11
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 12
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 13
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 14
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 15
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 16
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 

==Macro reference==

Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetAscii
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetNumber
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetIndex
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Output Mode
 
Fc9-type-19-icon.png Port
 
Fc9-conn-icon.png Appearance
Fc9-type-1-icon.png Backplate Colour
 
Fc9-conn-icon.png Button 1
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 2
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 3
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 4
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 5
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 6
Fc9-type-1-icon.png 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. 
Fc9-type-2-icon.png 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. 
Fc9-conn-icon.png Button 7
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 8
Fc9-type-1-icon.png 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. 
Fc9-type-2-icon.png 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. 
Fc9-conn-icon.png Button 9
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 10
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 11
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 12
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 13
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 14
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 15
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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. 
Fc9-conn-icon.png Button 16
Fc9-type-1-icon.png 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. 
Fc9-type-1-icon.png 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.