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

Revision as of 12:01, 3 February 2023

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_temp/Keypad_Numeric.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/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 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_Numeric.fcfx FC_Comp_Source_Keypad_Numeric.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/Keypad_Numeric.fcfx FC_Comp_Source_temp/Keypad_Numeric.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Keypad_Numeric.fcfx FC_Comp_Source_Keypad_Numeric.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/Keypad_Numeric.fcfx FC_Comp_Source_temp/Keypad_Numeric.fcfx]
 ==Detailed description==
@@ Line 68: / Line 68: @@
 {{Fcfile|Keypad Door Entry.fcfx.fcfx|Keypad Door Entry}}
@@ Line 75: / Line 77: @@
 ==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 89: / Line 91: @@
-===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 103: / Line 105: @@
-===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;
 |-
 |-

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

Revision as of 12:01, 3 February 2023

Contents