Component: Keypad (Numeric 3x4) (Keypad): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix Ltd
Version	1.0
Category	Keypad

Keypad (Numeric 3x4) component

Preset keypad based around the 3 * 4 unit, as used by the Matrix EB014 E-block

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

Basic Example

Keypad Example File demonstrating controlling a door lock.

LED is used to show the pin status controlling the door lock.

Keypad Door Entry

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
	Connections
	Port
From here, set the port to which your EB014 is connected. If you are wiring your own hardware, you can use the 'Custom Pins' setting to allow the selection of individual pins for each row or column.

@@ Line 67: / Line 67: @@
 LED is used to show the pin status controlling the door lock.
-{{Fcfile|Keypad Door Entry.fcfx.fcfx|Keypad Door Entry}}
+{{Fcfile|Keypad Door Entry.fcfx|Keypad Door Entry}}
 ==Macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===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.&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 86: / Line 85: @@
-{| 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.&nbsp;
+| colspan="2" | Gets the index value for the current keypress. If no key pressed then the macro returns the value 255.&nbsp;
 |-
 |-
@@ Line 99: / Line 99: @@
-{| 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.&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''
 |}
-{| 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.&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''
 |}
-{| 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.&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;
 |-
 |-
@@ Line 138: / Line 141: @@
-{| 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.&nbsp;
@@ Line 149: / Line 153: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
 ==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;" | Connections
+| width="90%" class="mtx-class-propfolder" | Connections
 |-
 |-

SteveT (talk | contribs)