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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
+
{| style="width:50%"
 
 
{| width="50%"
 
 
|-
 
|-
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Keypad
 
| Keypad
 
|}
 
|}
  
  
 
+
==Keypad component==
==[[File:Component Icon 6c74b9ee_2907_4b1e_8a9b_80fc192b6027.png|Image]] Keypad (4x4) component==
 
 
Preset keypad based around the 4 * 4 unit.
 
Preset keypad based around the 4 * 4 unit.
  
==Examples==
+
==Component Source Code==
''<span style="color:red;">No additional examples</span>''
 
  
 +
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]
  
==Downloadable macro reference==
+
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]
  
===<span style="font-weight: normal;"><u><tt>WaitPressed</tt></u></span>===
+
==Detailed description==
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.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
 
  
:[[Variable Types|BYTE]] : Index of the first key pressed.
 
  
  
===<span style="font-weight: normal;"><u><tt>GetAscii</tt></u></span>===
 
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
 
  
:[[Variable Types|BYTE]] : ASCII code of the pressed switch (or 255 if none pressed)
 
  
  
===<span style="font-weight: normal;"><u><tt>GetString</tt></u></span>===
 
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.
 
  
'''Parameters'''
+
''No detailed description exists yet for this component''
  
:''This macro has no parameters''
+
==Examples==
  
  
'''Return value'''
 
  
:[[Variable Types|STRING]] : Single character representing the pressed key, or an empty string if none pressed.
 
  
  
===<span style="font-weight: normal;"><u><tt>GetNumber</tt></u></span>===
 
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
 
  
:[[Variable Types|BYTE]] : Number return value of the pressed key, or 255 if none pressed.
 
  
  
===<span style="font-weight: normal;"><u><tt>GetIndex</tt></u></span>===
 
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
+
''<span style="color:red;">No additional examples</span>''
  
:[[Variable Types|BYTE]] : Index of the pressed switch, or 255 if none pressed.
 
  
  
===<span style="font-weight: normal;"><u><tt>WaitReleased</tt></u></span>===
 
Blocking call that waits for the keys on the keypad to be released. If no key is pressed then the function will return immediatley.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
 
  
:''This call does not return a value''
 
  
  
  
==Simulation macro reference==
 
  
''This component does not contain any simulation macros''
+
==Macro reference==
  
 +
===GetAscii===
 +
{| 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.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
==Property reference==
 
<span style="font-weight: normal;"><u>Column 1</u></span>
 
  
This property is of type ''Single digital pin'' and can be referenced with the variable name ''keypad_base::pin_col1''.
+
===GetIndex===
 +
{| 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.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
Pin for the first column of keys.
 
  
Columns are counted from left to right.
+
===GetNumber===
 +
{| 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.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
<span style="font-weight: normal;"><u>Column 2</u></span>
 
  
This property is of type ''Single digital pin'' and can be referenced with the variable name ''keypad_base::pin_col2''.
+
===GetString===
 +
{| 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.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
Pin for the second column of keys.
 
  
Columns are counted from left to right.
+
===WaitPressed===
 +
{| 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.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
<span style="font-weight: normal;"><u>Column 3</u></span>
 
  
This property is of type ''Single digital pin'' and can be referenced with the variable name ''keypad_base::pin_col3''.
+
===WaitReleased===
 +
{| 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.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
Pin for the third column of keys.
 
  
Columns are counted from left to right.
+
==Property reference==
  
<span style="font-weight: normal;"><u>Column 4</u></span>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''keypad_base::pin_col4''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
Pin for the fourth column of keys.
+
|-
 
+
|-
Columns are counted from left to right.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
<span style="font-weight: normal;"><u>Row 1</u></span>
+
|-
 
+
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''keypad_base::pin_row1''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
+
| width="90%" | Output Mode
Pin for the first row of keys.
+
|-
 
+
| colspan="2" | &nbsp;
Columns are counted from top to bottom by default - they can be counted from bottom to top
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-19-icon.png]]
by changing the 'First Row' property in the 'Dimensions' section.
+
| width="90%" | Port
 
+
|-
<span style="font-weight: normal;"><u>Row 2</u></span>
+
| colspan="2" | &nbsp;
 
+
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''keypad_base::pin_row2''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance
Pin for the second row of keys.
+
|-
 
+
|-
Columns are counted from top to bottom by default - they can be counted from bottom to top
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 
+
| width="90%" | Backplate Colour
by changing the 'First Row' property in the 'Dimensions' section.
+
|-
 
+
| colspan="2" | &nbsp;
<span style="font-weight: normal;"><u>Row 3</u></span>
+
|-
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
This property is of type ''Single digital pin'' and can be referenced with the variable name ''keypad_base::pin_row3''.
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 1
 
+
|-
Pin for the third row of keys.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
Columns are counted from top to bottom by default - they can be counted from bottom to top
+
| width="90%" | Key colour
 
+
|-
by changing the 'First Row' property in the 'Dimensions' section.
+
| 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.&nbsp;
 
+
|-
<span style="font-weight: normal;"><u>Row 4</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 
+
| width="90%" | Label colour
This property is of type ''Single digital pin'' and can be referenced with the variable name ''keypad_base::pin_row4''.
+
|-
 
+
| 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.&nbsp;
Pin for the fourth row of keys.
+
|-
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
Columns are counted from top to bottom by default - they can be counted from bottom to top
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 2
 
+
|-
by changing the 'First Row' property in the 'Dimensions' section.
+
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|}

Latest revision as of 13:11, 7 February 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

GetAscii

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


GetIndex

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


GetNumber

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


GetString

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


WaitPressed

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


WaitReleased

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.