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

Revision as of 12:01, 3 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_temp/Keypad_Base.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/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

@@ Line 17: / Line 17: @@
 ==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 download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/Keypad_Base.fcfx FC_Comp_Source_temp/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_temp/Keypad_Base.fcfx FC_Comp_Source_temp/Keypad_Base.fcfx]
 ==Detailed description==
@@ Line 79: / Line 79: @@
 [[File:KeypadCirBuff.jpg]]
@@ Line 86: / Line 88: @@
 ==Macro reference==
-===WaitPressed===
+===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;" | '''WaitPressed'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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.&nbsp;
+| colspan="2" | Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255.&nbsp;
 |-
 |-
@@ Line 100: / Line 102: @@
-===GetAscii===
+===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;" | '''GetAscii'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIndex'''
 |-
-| colspan="2" | Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255.&nbsp;
+| colspan="2" | Gets the index value for the current keypress. If no key pressed then the macro returns the value 255.&nbsp;
 |-
 |-
@@ Line 114: / Line 116: @@
-===GetString===
+===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;" | '''GetString'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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.&nbsp;
+| 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-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''
 |}
-===GetNumber===
+===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;" | '''GetNumber'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetString'''
 |-
-| colspan="2" | Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255.&nbsp;
+| 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.&nbsp;
 |-
 |-
-| 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''
 |}
-===GetIndex===
+===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;" | '''GetIndex'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WaitPressed'''
 |-
-| colspan="2" | Gets the index value for the current keypress. If no key pressed then the macro returns the value 255.&nbsp;
+| 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;
 |-
 |-