Difference between revisions of "Component: Keypad (Generic) (Keypad)"

From Flowcode Help
Jump to navigationJump to search
 
(6 intermediate revisions by the same user not shown)
Line 16: Line 16:
  
 
==Component Source Code==
 
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Keypad_Base.fcfx FC_Comp_Source_Keypad_Base.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Keypad_Base.fcfx FC_Comp_Source_Keypad_Base.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Keypad_Base.fcfx FC_Comp_Source_Keypad_Base.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
  
  
Line 32: Line 40:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
  
  
Line 66: Line 80:
 
[[File:KeypadCirBuff.jpg]]
 
[[File:KeypadCirBuff.jpg]]
  
−
==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 a null string. 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
  
 +
==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;" | '''WaitReleased'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAscii'''
 
|-
 
|-
−
| 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" | 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-void-icon.png]] - VOID
+
| 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''
 
|}
 
|}
  
  
−
 
+
===GetIndex===
−
 
 
−
==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;" | Dimensions
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Keys
 
−
|-
 
−
| colspan="2" | Number of columns (left to right) in the array of keys. Must be a value from one to four. 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Return Values
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | ASCII
 
−
|-
 
−
| colspan="2" | A list of return values for the 'GetString' and 'GetASCII' macros.  Enter a string with one character per key, in order of key scanning. Columns are counted first (left-to-right), then rows (direction set by the 'First Row' property) e.g. for a 2*2 grid, the order would be... [Row0, Column0], [Row0,Column1], ][Row1, Column0], [Row1, Column1] 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
 
−
| width="90%" | Numbers
 
−
|-
 
−
| colspan="2" | A list of return values for the 'GetNumber' macro.  Enter a comma separated list with one integer value per key, in order of key scanning. Columns are counted first (left-to-right), then rows (direction set by the 'First Row' property) e.g. for a 2*2 grid, the order would be... [Row0, Column0], [Row0,Column1], ][Row1, Column0], [Row1, Column1] 
 
−
|-
 
−
| 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-16-icon.png]]
 
−
| width="90%" | Style
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" |  Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the fill colour of the shape 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
−
| width="90%" | Colour
 
−
|-
 
−
| colspan="2" | Specifies the font colour for the item 
 
−
|}==Macro reference==
 
−
 
 
 
{| 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;" | '''WaitPressed'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIndex'''
 
|-
 
|-
−
| 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. 
+
| colspan="2" | Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. 
 
|-
 
|-
 
|-
 
|-
Line 504: Line 120:
  
  
 +
===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;" | '''GetAscii'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetNumber'''
 
|-
 
|-
−
| colspan="2" | Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. 
+
| colspan="2" | Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. 
 
|-
 
|-
 
|-
 
|-
Line 517: Line 134:
  
  
 +
===GetString===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 530: Line 148:
  
  
 +
===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;" | '''GetNumber'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WaitPressed'''
 
|-
 
|-
−
| colspan="2" | Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. 
+
| 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;" | '''GetIndex'''
 
−
|-
 
−
| colspan="2" | Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. 
 
 
|-
 
|-
 
|-
 
|-
Line 556: Line 162:
  
  
 +
===WaitReleased===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 567: Line 174:
 
| 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 Ltd
Version 1.5
Category Keypad


Keypad (Generic) component

Generic component to create a raster scanned custom keypad or button matrix. By default, each key is labelled with its ASCII return character. Alternatively, each key may use an image as a label. To use a custom key shape, build a single key, then point to it with the 'Custom key shape" property. If the custom shape is a group, any item within the group that has a handle beginning with "label" will have the key label/image applied to it automatically.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Keypad_Base.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Keypad_Base.fcfx

Detailed description

No detailed description exists yet for this component

Examples

3 x 4 Keypad Schematic

Example schematic of a 3 x 4 Keypad.

KeypadSchematic2.jpg


Multi Digit Number Entry

A simple example to take in a decimal number (0-65535) from the user and then use this number as a delay for flashing a LED on and off. Shows the principals of reading the keypad and building up a multi-digit number.

FC6 Icon.png Keypad Delay


Keypad Based Door Entry System

Each key press on the keypad is fed into the Circular Buffer component. We then poll the buffer to see if the correct characters for the password have been entered.

FC6 Icon.png Keypad Door Entry

If the correct sequence is detected then we activate the solenoid component for 5 seconds.

KeypadCirBuff.jpg






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 a null string. 
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 Dimensions
Fc9-type-16-icon.png Keys
Number of columns (left to right) in the array of keys. Must be a value from one to four. 
Fc9-conn-icon.png Return Values
Fc9-type-10-icon.png ASCII
A list of return values for the 'GetString' and 'GetASCII' macros. Enter a string with one character per key, in order of key scanning. Columns are counted first (left-to-right), then rows (direction set by the 'First Row' property) e.g. for a 2*2 grid, the order would be... [Row0, Column0], [Row0,Column1], ][Row1, Column0], [Row1, Column1] 
Fc9-type-11-icon.png Numbers
A list of return values for the 'GetNumber' macro. Enter a comma separated list with one integer value per key, in order of key scanning. Columns are counted first (left-to-right), then rows (direction set by the 'First Row' property) e.g. for a 2*2 grid, the order would be... [Row0, Column0], [Row0,Column1], ][Row1, Column0], [Row1, Column1] 
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-16-icon.png Style
 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Fc9-conn-icon.png Button
Fc9-type-2-icon.png Colour
Specifies the fill colour of the shape 
Fc9-conn-icon.png Label
Fc9-type-2-icon.png Colour
Specifies the font colour for the item 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Keypad_(Generic)_(Keypad)&oldid=38115"