Jump to content

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

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,422 edits
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(15 intermediate revisions by 2 users not shown)
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Keypad_Base.fcfx FC_Comp_Source_Keypad_Base.fcfx]
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]


==Detailed description==
==Detailed description==




Line 26: Line 40:


==Examples==
==Examples==




Line 54: Line 80:
[[File:KeypadCirBuff.jpg]]
[[File:KeypadCirBuff.jpg]]


==Downloadable macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
 
 
 
 
 
 
 
==Macro reference==
 
===GetAscii===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WaitPressed'''
| width="90%" class="mtx-class-macrohead" | '''GetAscii'''
|-
|-
| 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 ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. 
|-
|-
|-
|-
Line 69: Line 106:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetIndex===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAscii'''
| width="90%" class="mtx-class-macrohead" | '''GetIndex'''
|-
|-
| 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 index value for the current keypress. If no key pressed then the macro returns the value 255. 
|-
|-
|-
|-
Line 82: Line 120:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetNumber===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetString'''
| width="90%" class="mtx-class-macrohead" | '''GetNumber'''
|-
|-
| 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. 
| 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-string-icon.png]] - STRING
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetString===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetNumber'''
| width="90%" class="mtx-class-macrohead" | '''GetString'''
|-
|-
| colspan="2" | Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. 
| 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-u8-icon.png]] - BYTE
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===WaitPressed===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIndex'''
| width="90%" class="mtx-class-macrohead" | '''WaitPressed'''
|-
|-
| colspan="2" | Gets the index 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. 
|-
|-
|-
|-
Line 121: Line 162:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===WaitReleased===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WaitReleased'''
| width="90%" class="mtx-class-macrohead" | '''WaitReleased'''
|-
|-
| colspan="2" | Blocking call that waits for the keys on the keypad to be released. If no key is pressed then the function will return immediatley. 
| colspan="2" | Blocking call that waits for the keys on the keypad to be released. If no key is pressed then the function will return immediatley. 
Line 132: Line 174:
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Dimensions
| width="90%" class="mtx-class-propfolder" | Dimensions
|-
|-
|-
|-
Line 153: Line 193:
| colspan="2" | Number of columns (left to right) in the array of keys. Must be a value from one to four. 
| 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="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Return Values
| width="90%" class="mtx-class-propfolder" | Return Values
|-
|-
|-
|-
Line 167: Line 207:
| 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] 
| 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="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
| width="90%" class="mtx-class-propfolder" | Connections
|-
|-
|-
|-
Line 181: Line 221:
| colspan="2" |  
| colspan="2" |  
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance
| width="90%" class="mtx-class-propfolder" | Appearance
|-
|-
|-
|-
Line 190: Line 230:
| colspan="2" |  
| colspan="2" |  
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 199: Line 239:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 208: Line 248:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 217: Line 257:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 226: Line 266:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 235: Line 275:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 244: Line 284:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 253: Line 293:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 262: Line 302:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 271: Line 311:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 280: Line 320:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 289: Line 329:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 298: Line 338:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 307: Line 347:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 316: Line 356:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 325: Line 365:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 334: Line 374:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 343: Line 383:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 352: Line 392:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 361: Line 401:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 370: Line 410:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 379: Line 419:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 388: Line 428:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 397: Line 437:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 406: Line 446:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 415: Line 455:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 424: Line 464:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 433: Line 473:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 442: Line 482:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 451: Line 491:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 460: Line 500:
| colspan="2" | Specifies the font colour for the item 
| colspan="2" | Specifies the font colour for the item 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button
| width="90%" class="mtx-class-propfolder" | Button
|-
|-
|-
|-
Line 469: Line 509:
| colspan="2" | Specifies the fill colour of the shape 
| colspan="2" | Specifies the fill colour of the shape 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-

Latest revision as of 14:36, 13 July 2026

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.


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.

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.

Keypad Door Entry

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






Macro reference

GetAscii

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


GetIndex

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


GetNumber

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


GetString

GetString
Gets the ASCII value for the current keypress and returns in the form of a string. If no key pressed then the macro returns a null string. 
- STRING Return


WaitPressed

WaitPressed
Blocking call that waits for one of the keys on the keypad to be pressed. The index of the key that was pressed is passed back to the user. 
- BYTE Return


WaitReleased

WaitReleased
Blocking call that waits for the keys on the keypad to be released. If no key is pressed then the function will return immediatley. 
- VOID Return


Property reference

Properties
Dimensions
Keys
Number of columns (left to right) in the array of keys. Must be a value from one to four. 
Return Values
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] 
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] 
Connections
Output Mode
 
Port
 
Appearance
Style
 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Button
Colour
Specifies the fill colour of the shape 
Label
Colour
Specifies the font colour for the item 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Keypad_(Generic)_(Keypad)&oldid=47767"