Example getkey - Revision history

Nperkins at 19:20, 30 November 2022

2022-11-30T19:20:24Z

Btisler: Added OE5 instructions

2020-09-25T16:20:40Z

Added OE5 instructions

Bserrano at 21:20, 3 April 2014

2014-04-03T21:20:27Z

Bserrano at 21:03, 3 April 2014

2014-04-03T21:03:38Z

Mdean: Added example building instructions.

2014-01-04T00:29:58Z

Added example building instructions.

Kyoungmeyer at 23:37, 3 January 2014

2014-01-03T23:37:44Z

Mdean: Approved for Final Draft status.

2014-01-03T23:17:12Z

Approved for Final Draft status.

Jgreene at 23:02, 3 January 2014

2014-01-03T23:02:08Z

Jgreene: /* Plugging the Keypad into the SOM-150ES Carrier Board */

2014-01-03T23:00:53Z

‎Plugging the Keypad into the SOM-150ES Carrier Board

Jgreene at 23:00, 3 January 2014

2014-01-03T23:00:02Z

← Older revision		Revision as of 19:20, 30 November 2022
Line 25:		Line 25:
	Alternatively, the <code>CMakefile.txt</code> can be used with the <code>cmake</code> command from the commandline to build and upload the example. For information on this method, please see [[Getting_Started_with_the_EMAC_OE_SDK#Target_Machine_Compiling \| Getting Started with the EMAC OE SDK]].		Alternatively, the <code>CMakefile.txt</code> can be used with the <code>cmake</code> command from the commandline to build and upload the example. For information on this method, please see [[Getting_Started_with_the_EMAC_OE_SDK#Target_Machine_Compiling \| Getting Started with the EMAC OE SDK]].

		+	Code can be found at http://git.emacinc.com/OE/example-projects
	==Usage and Behavior==		==Usage and Behavior==

@@ Line 17: / Line 17: @@
 For information on opening the project from within Eclipse, please see [[Importing the EMAC OE SDK Projects with Eclipse]].  Then, follow [[Using the EMAC OE SDK Projects with Eclipse]] for information on how to build, upload and execute the example.
-Alternatively, the <code>Makefile</code> can be used with the <code>make</code> command from the commandline to build and upload the example.  For more information on this method, please see [[Using EMAC OE SDK Example Projects]].
+Alternatively, the <code>Makefile</code> can be used with the <code>make</code> command from the commandline to build and upload the example.  For information on this method, please see [[Using EMAC OE SDK Example Projects]].
 ==Usage and Behavior==

@@ Line 1: / Line 1: @@
-{{todo|SEOKWREV (11.14.13-11:41->JG+);(11.14.13-15:30->MD-);(11.21.13-14:06->JG+);(11.21.13-16:15->MD-);(12.03.13-14:21->JG+);(01.04.14-17:01->JG+);(01.03.14-17:15->MD+);(01.03.14-17:35->KY+);(04.03.14-15:45->BS+)|Jgreene|project=oe 4,oe 5,jg,md,SEOKWREV,ky,bs}}
+{{todo|SEOKWREV (11.14.13-11:41->JG+);(11.14.13-15:30->MD-);(11.21.13-14:06->JG+);(11.21.13-16:15->MD-);(12.03.13-14:21->JG+);(01.04.14-17:01->JG+);(01.03.14-17:15->MD+);(01.03.14-17:35->KY+);(04.03.14-16:20->BS+)|Jgreene|project=oe 4,oe 5,jg,md,SEOKWREV,ky,bs}}
 {{#seo:
 |title=Example getkey
 |titlemode=append
-|keywords=Example getkey,EMAC SOM-150ES,Using getkey,EMAC SOM-9260M,EMAC SOM-9620M,EMAC SOM-9X25
+|keywords=Example getkey,EMAC SOM-150ES,Using getkey,E020-21 Membrane hex style keypad
 |description=This is a guide to the <code>getkey</code> C example project included in the EMAC OE SDK.
 }}

← Older revision		Revision as of 21:03, 3 April 2014
Line 1:		Line 1:
−	{{todo\|~~Complete~~ (11.14.13-11:41->JG+);(11.14.13-15:30->MD-);(11.21.13-14:06->JG+);(11.21.13-16:15->MD-);(12.03.13-14:21->JG+);(01.04.14-17:01->JG+);(01.03.14-17:15->MD+);(01.03.14-17:35->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,~~Complete~~,ky}}	+	{{todo\|SEOKWREV (11.14.13-11:41->JG+);(11.14.13-15:30->MD-);(11.21.13-14:06->JG+);(11.21.13-16:15->MD-);(12.03.13-14:21->JG+);(01.04.14-17:01->JG+);(01.03.14-17:15->MD+);(01.03.14-17:35->KY+);(04.03.14-15:45->BS+)\|Jgreene\|project=oe 4,oe 5,jg,md,SEOKWREV,ky,bs}}
		+
		+	{{#seo:
		+	\|title=Example getkey
		+	\|titlemode=append
		+	\|keywords=Example getkey,EMAC SOM-150ES,Using getkey,EMAC SOM-9260M,EMAC SOM-9620M,EMAC SOM-9X25
		+	\|description=This is a guide to the <code>getkey</code> C example project included in the EMAC OE SDK.
		+	}}
	This is a guide to the <code>getkey</code> C example project included in the EMAC OE SDK.		This is a guide to the <code>getkey</code> C example project included in the EMAC OE SDK.

@@ Line 6: / Line 6: @@
 The <code>getkey</code> C example project creates one executable: <code>getkey</code>.
-stub
+== Opening, Building and Uploading the Project Files ==
 ==Usage and Behavior==

← Older revision		Revision as of 23:37, 3 January 2014
Line 1:		Line 1:
−	{{todo\|~~FinalDraft~~ (11.14.13-11:41->JG+);(11.14.13-15:30->MD-);(11.21.13-14:06->JG+);(11.21.13-16:15->MD-);(12.03.13-14:21->JG+);(01.04.14-17:01->JG+);(01.03.14-17:15->MD+)\|Jgreene\|project=oe 4,oe 5,jg,md,~~FinalDraft~~,ky}}	+	{{todo\|Complete (11.14.13-11:41->JG+);(11.14.13-15:30->MD-);(11.21.13-14:06->JG+);(11.21.13-16:15->MD-);(12.03.13-14:21->JG+);(01.04.14-17:01->JG+);(01.03.14-17:15->MD+);(01.03.14-17:35->KY+)\|Jgreene\|project=oe 4,oe 5,jg,md,Complete,ky}}
	This is a guide to the <code>getkey</code> C example project included in the EMAC OE SDK.		This is a guide to the <code>getkey</code> C example project included in the EMAC OE SDK.

@@ Line 1: / Line 1: @@
-{{todo|(11.14.13-11:41->JG+);(11.14.13-15:30->MD-);(11.21.13-14:06->JG+);(11.21.13-16:15->MD-);(12.03.13-14:21->JG+);(01.04.14-17:01->JG+)|Jgreene|project=oe 4,oe 5,jg,md,Review}}
+{{todo|FinalDraft (11.14.13-11:41->JG+);(11.14.13-15:30->MD-);(11.21.13-14:06->JG+);(11.21.13-16:15->MD-);(12.03.13-14:21->JG+);(01.04.14-17:01->JG+);(01.03.14-17:15->MD+)|Jgreene|project=oe 4,oe 5,jg,md,FinalDraft,ky}}
 This is a guide to the <code>getkey</code> C example project included in the EMAC OE SDK.
@@ Line 39: / Line 39: @@
 ====A Note on Matrix Encoding====
-Matrix Encoding is a technique for translating individual xy locations on a 2d matrix into unique integer values. Here we see locations in a 4x4 matrix being translated into an 8bit value. Pins 0,1,2,3 handle the key y coordinate; pins 4,5,6,7 handle the x coordinate. Key '''A''' is at (7,0); '''B''':(6,0); '''K''':(5,2); Etc.
+Matrix Encoding is a technique for translating individual xy locations on a 2D matrix into unique integer values. Here we see locations in a 4x4 matrix being translated into an 8-bit value. Pins 0, 1, 2, 3 handle the key y coordinate; pins 4, 5, 6, 7 handle the x coordinate. Key '''A''' is at (7,0); '''B''':(6,0); '''K''':(5,2); Etc.
 &nbsp; &nbsp; &nbsp; &nbsp; [[File:Matrix encoding.png]]
-Thus, when a key is pressed, we get a corrosponding integer value on the header.<br />
+Thus, when a key is pressed, we get a corresponding integer value on the header.<br />
-For example: Pressing the '''F''' key sets the values on pins '''1''' and '''6''' to 1. This gives us a binary value of 01000010. Integer value: 66 . So when the value at the header equals 66 we know that the '''F''' key was pressed.<br />
+For example: Pressing the '''F''' key sets the values on pins '''1''' and '''6''' to 1. This gives us a binary value of 01000010. Integer value: 66 . So when the value at the header equals 66, we know that the '''F''' key was pressed.<br />
-'''Note''' This is an abstract, general example of a keypad using matrix encoding. Your keypad will probably have different characters on it's keys and output slightly different values.
+'''Note:''' This is an abstract, general example of a keypad using matrix encoding. Your keypad will probably have different characters on it's keys and output slightly different values.
 ===Using getkey===
@@ Line 58: / Line 58: @@
 ;-s:Specify the keypad matrix file. (see notes on the [http://wikidev.emacinc.com/wiki/Example_getkey#The_Keypad_Matrix_File keypad matrix file], above). If a keypad matrix file is not specified then the character associated with the last keypad key pressed is returned.
-'''Note on parameter order.''' Parameters are evaluated in order. If blocking ('''b''') or device specifications ('''d''') are used, they must be declared before the matrix arguments on the command line.
+'''Note on parameter order:''' Parameters are evaluated in order. If blocking ('''b''') or device specifications ('''d''') are used, they must be declared before the matrix arguments on the command line.
 ===Usage Example. Mapping a Keypad Device Node to a Keypad Matrix File===
@@ Line 66: / Line 66: @@
 The program will map the keypad at the device node <code>/dev/keypad0</code> to the matrix file <code>Key-E020-21</code>. This associates each character in the grid of characters in the matrix file (see notes on the [http://wikidev.emacinc.com/wiki/Example_getkey#The_Keypad_Matrix_File keypad matrix file], above) with a key in the grid of keys on the keypad.
-===Usage Example. Displaying the Character Presently Associated With a Key on the Keypad===
+===Usage Example: Displaying the Character Presently Associated With a Key on the Keypad===
   <code>./getkey -d /dev/keypad0 -b</code>
@@ Line 78: / Line 78: @@
 root@som9g20:/tmp#
 </syntaxhighlight>
-In this case I pressed the '''5''' key on the keypad.
+In this case, the '''5''' key on the keypad was pressed.
 ===Usage Example. Displaying the Character Matrix Presently Associated with the Keypad===
@@ Line 98: / Line 98: @@
 ==Summary==
-The <code>getkey<code example C project demonstrates how to use a keypad with a SoM150ES carrier board.
+The <code>getkey</code> example C project demonstrates how to use a keypad with a SoM150ES carrier board.

← Older revision		Revision as of 23:02, 3 January 2014
Line 1:		Line 1:
−	{{todo\|(11.14.13-11:41->JG+);(11.14.13-15:30->MD-);(11.21.13-14:06->JG+);(11.21.13-16:15->MD-);(12.03.13-14:21->JG+)\|Jgreene\|project=oe 4,oe 5,jg,md,~~InProgress~~}}	+	{{todo\|(11.14.13-11:41->JG+);(11.14.13-15:30->MD-);(11.21.13-14:06->JG+);(11.21.13-16:15->MD-);(12.03.13-14:21->JG+);(01.04.14-17:01->JG+)\|Jgreene\|project=oe 4,oe 5,jg,md,Review}}
	This is a guide to the <code>getkey</code> C example project included in the EMAC OE SDK.		This is a guide to the <code>getkey</code> C example project included in the EMAC OE SDK.

@@ Line 26: / Line 26: @@
 [[File:Example getkey howtopluginthekeypad 0.png|500px]]
-Make sure that you line up '''pin 0''' of the keypad's ribbon cable with '''pin 2''' of the header.<br />
+Ensure that '''pin 0''' of the keypad's ribbon cable is lined up with '''pin 2''' on the header.<br />
 [[File:Example getkey howtopluginthekeypad 1.png|500px]]

@@ Line 2: / Line 2: @@
 This is a guide to the <code>getkey</code> C example project included in the EMAC OE SDK.
-The <code>getkey</code> example C project demonstrates how to use a keypad with a SoM150ES carrier board. It provides examples of how to specify, inspect and test associations between character-data and keypad-keys. It demonstrates how to turn key-presses into character-data using the same techniques as the big keyboard on your PC. It is a good introduction to the mysteries of matrix encoding (see [http://wikidev.emacinc.com/wiki/Example_getkey#A_Note_on_Matrix_Encoding A Note on Matrix Encoding, below]).
+The <code>getkey</code> example C project demonstrates how to use a keypad with a SoM150ES carrier board. It provides examples of how to specify, inspect and test associations between character-data and keypad-keys. It demonstrates how to turn key-presses into character-data using the same techniques as the big keyboard on your PC. It's also a good introduction to the mysteries of matrix encoding (see [http://wikidev.emacinc.com/wiki/Example_getkey#A_Note_on_Matrix_Encoding A Note on Matrix Encoding, below]).
 The <code>getkey</code> C example project creates one executable: <code>getkey</code>.