wiki.emacinc.com - User contributions [en]

LED example

2022-11-30T19:23:03Z

Nperkins:

{{#seo:
|title=Example ipac_led
|titlemode=append
|keywords=Example,ipac,demo,EMAC C example project
|description=This is a guide to the <code>ipac_led</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>ipac_led</code> C example project included in the EMAC OE SDK.

This project demonstrated the use of the iPac9x25's GPIOs to designate the LEDs output.

The <code>ipac_led</code> project builds one executable: <code>ipac_led_demo</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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==

===Hardware Requirements===

The <code>ipac_led</code> C example project will run on the iPac9x25 device.

===Using <code>ipac_led_demo</code>===

The <code>ipac_led_demo</code> program is executed from the console. It takes no parameters.

<code>./ipac_led_demo</code>

The program has 3 examples that illuminate the 8 LED on the iPac9x25 in different orders.

===Usage Example===

<syntaxhighlight lang="console">
root@ipac9x25:~# ./ipac_led_demo

Select the number of the example you would like to see.
1. Turn all on, then off.
2. Single light up the line, then back down.
3. Alternate back and forth.
Enter 0 to exit.
</syntaxhighlight>

Enter the number into the command line to see the example run on the iPac9x25.

==Summary==

The <code>ipac_led</code> C example project demonstrates use of GPIOs with the iPac9x25 LEDs.

Example watchdog

2022-11-30T19:22:51Z

Nperkins:

{{todo|Complete (01.03.14-11:32->JG+);(01.03.14-11:42->MD-);(02.04.14-19:30->MD);(02.06.14-17:32->BS+);(02.06.14-19:15->MD+);(04.07.14-10:15->BS+);(04.10.14-11:50->BS+);(11.10.15-15:30->MG+)|Brian Serrano|project=oe 4,oe 5,bs,md,SEOKWREV,Complete}}

{{#seo:
|title=Example watchdog
|titlemode=append
|keywords=Example watchdog,watchdog timer,watchdog test,Linux watchdog
|description=This is a guide to the <code>watchdog</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>watchdog</code> C example project included in the EMAC OE SDK.

A '''watchdog timer''' (WDT) is a hardware circuit that can reset the computer system in case of a software fault. This is an example test for the Linux watchdog API.

For more information about the protocol see the following page: http://en.wikipedia.org/wiki/Watchdog_timer

The <code>watchdog</code> project builds one executable: <code>watchdog-test</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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==

A '''watchdog timer''' is a hardware circuit that can reset the computer system in case of a software fault. The <code>watchdog-test</code> application can enable, disable, activate, configure and interrupt the '''watchdog timer'''.
{{note| Activating watchdog invokes system reset (after timeout)}}

===Hardware Requirements===

<code>watchdog</code> will run on any system for which it can be compiled and implements the standard Linux <code>watchdog</code> API.

===<code>watchdog</code> Usage===

{{cli | ./watchdog-test [-det] | hostname=emac-oe}}

;-d:Disable watchdog.
;-e:Enable watchdog.
;-t:Set the watchdog timeout (to a value specified in code. Default is five seconds).

===Usage Example. Activating <code>watchdog</code> with a periodic interrupt===

This will activate <code>watchdog</code> and initiate a periodic interrupt to keep it from timing out.

{{clo}}
{{clio | pwd=/tmp | hostname=emac-oe | ./watchdog-test }}
Watchdog Ticking Away!
{{clos}}
Every second <code>watchdog-test</code> is sending an IOCTL to the watchdog driver, which in turn ticks <code>watchdog</code> to reset its internal timer so it doesn't timeout and trigger a system reset.

Now we will stop interrupting <code>watchdog</code> and let it trigger a computer reset by pressing ''Ctrl+C''.

===Usage Example. Disabling <code>watchdog</code>===

{{clo}}
{{clio | pwd=/tmp | hostname=emac-oe | ./watchdog-test -d }}
Watchdog card disabled.
{{clos}}

After running the <code>./watchdog-test -d</code> command, the program exits normally.

===Usage Example. Enabling <code>watchdog</code>===

This will enable and activate <code>watchdog</code> but it won't perform a periodic timeout interrupt (see the first usage example, above). So when you run it the program activates <code>watchdog</code> and then <code>watchdog</code> resets the system.

{{clo}}
{{clio | pwd=/tmp | hostname=emac-oe | ./watchdog-test -e }}
Watchdog card enabled.
{{clos}}

After running the <code>./watchdog-test -e</code> command, the system resets.

===Usage Example. Setting <code>watchdog</code> timeout===

This will activate <code>watchdog</code> and set it to timeout in 5 seconds.

{{clo}}
{{clio | pwd=/tmp | hostname=emac-oe | ./watchdog-test -t }}
Watchdog timeout set to 5 seconds!

{{clos}}

After running the <code>./watchdog-test -t</code> command, the program exits normally. Once it exits, 5 seconds will elapse, and then the system resets.

==Summary==

The <code>watchdog</code> C example project demonstrates how to use the '''watchdog timer'''. The '''watchdog timer''' is there to help ensure that your system will return to a functional state should your program get stuck while executing.

EMAC provides examples of how to enable, disable, activate, configure and interrupt the <code>watchdog</code> hardware circuit. To use <code>watchdog</code> peripheral in Linux you will need a <code>watchdog</code> driver, and a <code>watchdog</code> device file. A device file is a special kind of virtual file which marks the device node in your root filesystem. Normally it's called <code>/dev/watchdog</code> .

Example timer

2022-11-30T19:22:41Z

Nperkins:

{{todo|SEOKWREV (01.02.14-12:45->JG+);(01.02.14-14:25->MD+);(01.02.14-15:40->MG+);(04.07.14-10:15->BS+);(04.10.14-11:35->BS+)|Jgreene|project=oe 4,oe 5,jg,md,SEOKWREV,bs}}

{{#seo:
|title=Example timer
|titlemode=append
|keywords=Example timer,Timer C,Software Timer
|description=This is a guide to the <code>timer</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>timer</code> C example project included in the EMAC OE SDK.

This project demonstrates how to use the software timer.

The <code>timer</code> project builds one executable: <code>timer</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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==

===Hardware Requirements===

The <code>timer</code> C example project will run just fine on any system for which it can be compiled.

===Using <code>timer</code>===

The <code>timer</code> program is executed from the console. It takes a single parameter.

<code>./timer frequency</code>

Where ''frequency'' specifies the frequency of the timer's tick cycle. 
It reports the delay between ticks, running until it is manually halted with a CTRL-C.

===Usage Example===

<syntaxhighlight lang="console">
root@som9g20:/tmp# ./timer 1
Starting timer at 1 HZ
delay : 1002 ms
delay : 1000 ms
delay : 1000 ms
.
.
.
delay : 1000 ms
delay : 1000 ms
^C

</syntaxhighlight>

Specifying 1 as our tick freqency, the timer cycles at a sedate 1000 ms (1 s) until we hit CTRL-C.

==Summary==

The <code>timer</code> C example project demonstrates how to use the software timer.

Example SPI test

2022-11-30T19:22:30Z

Nperkins:

{{todo|Buggy (2.21.14-17:40->BS+);(2.24.14-13:00->MD-)(2.28.14-17:48->BS+)(03.10.14-13:30->MD-)(08.27.14-16:55->BS+)(09.09.14-17:20->MD-)(09.10.14-17:00->BS+)(09.13.14-21:40->MD+) |Brian Serrano|project=oe 4,md,Complete,bs}}

This is a guide to the <code>spi_test</code> example project included in the EMAC OE SDK.

The <code>SPI</code> protocol works in a master/slave setup. The master is responsible for sending the clock pulses. At each clock pulse, data will be sent and received. The rising or the falling clock edge will be used to synchronize the transfer depending on the CPOL setting.

<code>SPI</code> devices have a slave select pin. Every device will share the <code>MISO</code> (Master Input Slave Output), <code>MOSI</code> (Master Output Slave Input), and <code>Clock</code> pins, but each device will have its own slave select pin (also know as chip select). The slave select pin is used to set one device to be active on the bus while deactivating the rest. Theoretically, this means a virtually unlimited number of devices can be used on the same <code>SPI</code> bus; in practice, the number is limited by a number of factors, such as required transaction rates, mechanisms (GPIO pins, bus expanders, etc) available for selecting specific devices, and physical routing constraints. The slave select pin can be active high or active low depending on the device.

The <code>SPI</code> protocol defines four signal lines, but only requires three to operate properly. The fourth line is only required if you have more than one device on the SPI bus; otherwise, you can hard-wire the chip select pin of the only device on the <code>SPI</code> bus so that it is always selected.

This procedure provides an overview of how to compile and run the <code>spi_test</code> C example project. This is an example test interface for sending a transaction to an EMAC <code>SPI</code> device interface. It is only relevant if the EMAC <code>SPI</code> device interface is enabled for an external <code>SPI</code> device that is connected to the bus. It assumes familiarity with the C programming language and is intended to be used by experienced programmers who are looking to learn the EMAC SDK.

For more information about the <code>SPI</code> protocol, see the following page: http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus

The <code>spi_test</code> project builds one executable: <code>spi_test</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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 ==
===Hardware Requirements===

The <code>spi_test</code> C example project will run on any EMAC carrier board which has an <code>SPI</code> interface (see also the [http://wikidev.emacinc.com/wiki/EMAC_SPI_Programming EMAC SPI Programming] page).

=== Using indexed_atod_test ===

The <code>indexed_atod_test</code> program is executed from the console. It takes two parameters.

root@emac-oe~:$ ./indexed_atod_test device channel

:* <code>device</code>: Name of the <code>indexed_atod</code> device node.
:* <code>channel</code>: Number of <code>indexed_atod</code> channels to be displayed.

{|style="margin: 0 auto;"
| [[File:Potentiometer3.jpg|left|thumb|300px|alt=A potentiometer circuit.|Figure 1: Potentiometer Circuit]]
| [[File:Hdr8_chan1.jpg|right|thumb|250px|alt=HDR8 Analog I/O|Figure 2: HDR8 ANALOG I/O]] 
|}

This example command was run on an EMAC SoM-150ES carrier board with a SoM-9G20M. This test uses a potentiometer for input to the A/D. You will be communicating with the mcp3208 chip, which is an 8-channel 12-bit A/D converter with SPI Serial Interface. Figure 1 provides a potentiometer test circuit for help on connection to the SoM-150ES carrier board. A circuit like this is recommended for familiarizing oneself with the A/D code before connecting the actual device to be measured by the A/D.

Before running the command in the terminal, you will need to connect the potentiometer to the carrier board as diagrammed. Figure 2 shows where to connect the potentiometer on Header 8 of the SoM-150ES. You will be focusing on CARR_ANL_1 for this example.

Turn the potentiometer counter-clockwise as far as it goes. You'll see the results when you run the command below. Test results will be displayed in the terminal.

<syntaxhighlight lang=console>
root@emac-oe~:$ ./indexed_atod_test /dev/mcp3208-gpio 4
[0] = 83
[1] = 4094
[2] = 61
[3] = 267
</syntaxhighlight>

The results that are displayed from the terminal show channel 1 analog value at 4094. All the other results are just noise coming from the mcp3208 chip. This noise can be virtually eliminated by grounding the unused A/D inputs.

For the second example, turn the potentiometer clockwise as far as it goes. You'll see how channel 1 results will change when running the command below. Test results will be displayed in the terminal.

<syntaxhighlight lang=console>
root@emac-oe~:$ ./indexed_atod_test /dev/mcp3208-gpio 4
[0] = 62
[1] = 0
[2] = 10
[3] = 95
</syntaxhighlight>

Here, the results show channel 1 analog value at zero. Your results may vary, depending on the characteristics of your potentiometer and the ADC noise present. You can alter the value by turning the potentiometer to different positions.

[[File:Hdr8_chan6.jpg|center|thumb|250px|alt=HDR8 Analog I/O|Figure 3: HDR8 ANALOG I/O]] 

Before doing example 3, you'll want to put the wiper (B) wire on pin 9 of the SoM-150ES carrier board. Figure 3 shows that pin 9 is CARR_ANL_6. Turn the potentiometer counter-clockwise about half way. You will see how the values on channel 6 will change when running the command below. Test results will be displayed in the terminal.

<syntaxhighlight lang=console>
root@emac-oe~:$ ./indexed_atod_test /dev/mcp3208-gpio 7
[0] = 53
[1] = 0
[2] = 56
[3] = 0
[4] = 29
[5] = 43
[6] = 2044
</syntaxhighlight>

The results show the channel 6 analog value at 2044, which is about half way (4095/2). You can change any of the channels value with the potentiometer as long as you put the wiper pin on the channel you want to change.

Due to ADC noise, you may see the values fluctuate slightly from one run to the next. This is normal behavior. This fluctuation can be more severe with some potentiometers than it is with others; some potentiometers are more prone to picking up noise. The noise will also be more severe with longer wires, due to transmission line effects. Eliminating noise is typically the greatest challenge in high resolution A/D conversion (especially at 18 bit and above), so you should expect to see some noise when performing an informal test such as this.

==Updates for iPac9x25==
In order to run these examples on the board, either follow the schematic from figure 4 or use part MIKROE-304.
{|style="margin: 0 auto;"
|[[File:Spi Test Schematic.png|thumb|Figure 4: Schematic used to set up spi test for iPac9x25]]
 
|}

== Summary ==
The <code>indexed_atod_test</code> C example project demonstrates how to use a 12 bit A/D converter chip (mcp3208) with SPI Serial Interface. <code>SPI</code> is simply a way to send data from device to device in a serial fashion (bit by bit). <code>SPI</code> provides good support for communication with peripheral devices that are accessed intermittently.

Example socket

2022-11-30T19:22:02Z

Nperkins:

{{todo|SEOKWREV (01.03.14-12:37->JG+);(01.03.14-14:00->MD+);(01.03.14-15:35->KY+);(04.07.14-10:10->BS+);(04.10.14-11:30->BS+)|Jgreene|project=oe 4,oe 5,jg,md,SEOKWREV,ky,bs}}

{{#seo:
|title=Example socket
|titlemode=append
|keywords=Example socket,Socket Server,Ethernet Network,Socket Client
|description=This is a guide to the <code>socket</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>socket</code> C example project included in the EMAC OE SDK.

This application demonstrates how to set up sockets for host and client nodes on an ethernet network.

The <code>socket</code> project builds one executable: <code>socket</code>.
== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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==

===Hardware Requirements===

The <code>socket</code> C example project will run just fine on any system for which it can be compiled.

===Using <code>socket</code>===

./socket -sc [ADDRESS] PORT

;-s:Create a ''server'', specify the PORT to listen to.
;-c:Create a ''client'', specify the server's ADDRESS and PORT.

For our demonstration we create a ''server'' and a ''client''. Upon activation the server waits for a connection. Upon activation the client connects with the server. When the server detects the client's connection it sends a message to the client. Then the client sends that message right back to the server. The server compares the message it sent to the client with the message it just got from the client. If they match then we have performed a successful transmission.

===Usage Example. One machine===

We're going to create a ''server'' and ''client'' on the same machine. The machine will talk to itself.

Create the server

'''Note''' We're using port ''9999''. It's arbitrarily chosen and assumed to be free.

<syntaxhighlight lang="text">
root@som9g20:/tmp# ./socket -s 9999

Starting server
Making socket
Binding to port 9999opened socket as fd (3) on port (9999) for stream i/o
Server
sin_family = 2
sin_addr.s_addr = 0
sin_port = 9999

Making a listen queue of 5 elements
Waiting for a connection
</syntaxhighlight>

...and it's waiting for a connection. Note that you can't do anything else in this console because it's occupied with the <code>socket</code> program. So open another console and, if necessary, log-on.

Create the client.

'''Note''' We're using port ''9999'', the same port for which the server is configured; and the localhost address: 127.0.0.1

<syntaxhighlight lang="text">
root@som9g20:/tmp# ./socket -c 127.0.0.1 9999

Making a socket
Connecting to 127.0.0.1 on port 9999
Received "Message from the socket server" from server

Writing "Message from the socket server" to server
Closing socket
</syntaxhighlight>

This is what happened: The server started up and waited for a connection. Then we started the client and it immediately connected to the server. The server noticed that connection and sent a message to the client: "Message from the socket server". The client received the message and sent it right back to the server. The server compared the two messages to check the accuracy of the transmission. The messages matched so the transmission was successful.

===Usage Example. Two machines===

Get 2 machines. In this example, a SoM9g20 and a SoM 9g45 are used. These machines will be referred to as ''MACHINE0'' and ''MACHINE1''. 
Compile and upload the <code>socket</code> executable to each of them. 
Connect them both to the same ethernet network. 

'''On MACHINE0 run the <code>socket</code> program.'''
som9g45:/tmp# ./socket -s 9999
Note that '''-s''' was specified, thus configuring MACHINE0 as a server. ''9999'' is an arbitrarily chosen (and assumed to be free) port address on the host machine.

MACHINE0 has now been configured as a server and is waiting for a connection.

'''On MACHINE1, run the <code>socket</code> program.'''
som9g20:/tmp# ./socket -c 10.0.2.204 9999
Note that the '''-c''' argument was specified, thus configuring MACHINE1 as a '''client'''. ''10.0.2.204'' is the host machine's address (this will need to be determined. Use ''minicom'' or a similar terminal program). ''9999'' is the port address on the host machine.

'''On MACHINE0, you will see something like this:'''
<syntaxhighlight lang="text">
som9g45:/tmp# ./socket -s 9999

Starting server
Making socket
Binding to port 9999opened socket as fd (3) on port (9999) for stream i/o
Server
sin_family = 2
sin_addr.s_addr = 0
sin_port = 9999

Making a listen queue of 5 elements
Waiting for a connection

Got a connection
Sending "Message from the socket server" to client
The messages match
Closing the socket
Waiting for a connection
</syntaxhighlight>

'''On MACHINE1, you will see something like this:'''
<syntaxhighlight lang="text">
root@som9g20:/tmp# ./socket -c 10.0.2.204 9999

Making a socket
Connecting to 10.0.2.204 on port 9999
Received "Message from the socket server" from server

Writing "Message from the socket server" to server
Closing socket
</syntaxhighlight>

This is what happened: MACHINE0 (the server) was configured as a server and waited for a connection. MACHINE1 (the client) connected to MACHINE0. MACHINE0 noticed the connection and sent a message to MACHINE1: "Message from the socket server". MACHINE1 received the message and sent it right back. MACHINE0 compared the two messages to check the accuracy of the transmission. The messages matched so the transmission was successful.

==Summary==
The <code>socket</code> C example project demonstrates how to set up host and client node sockets on an ethernet network.

Example serial

2022-11-30T19:21:51Z

Nperkins:

{{todo|SEOKWREV (12.31.13-14:56->JG+);(1.2.14-11:20->MD+);(1.2.14-15:35->MG+);(04.07.14-10:00->BS+);(04.10.14-11:20->BS+)|Jgreene|project=oe 4,oe 5,jg,md,SEOKWREV,mg,bs}}

{{#seo:
|title=serial test
|titlemode=append
|keywords=Serial Test,Serial Port,Asynchronous
|description=This is a guide to the <code>serial</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>serial</code> C example project included in the EMAC OE SDK.

This application sets up and tests asynchronous IO on a serial port using '''poll()''' and '''fasync()'''.

The <code>serial</code> project builds one executable: <code>serial_test</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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==

<code>serial_test</code> performs an asynchronous IO test on the specified serial device using either '''poll''' or '''FASYNC''' mode. It performs the test, reports, tests, report, etc. It will keep running until it is stopped manually via '''CTRL-C'''.

===Hardware Requirements===

It should run just fine on any device with a serial port.

===Using <code>serial_test</code>===

<code>./serial_test DEVICE -[p] [-f]</code>

;DEVICE: The serial device to use
;-p: Use '''poll''' mode for asynchronous IO
;-f: Use '''FASYNC''' mode for asynchronous IO

===Usage Example: Test asynchronous IO using the '''poll''' mode===

Perform the test on device <code>/dev/ttyS1</code>

<syntaxhighlight lang="text">
root@som9g20:/tmp# ./serial_test /dev/ttyS1 -p
Testing on /dev/ttyS1 using poll()
Received: : 21
Received: : 11
Received: : 6
Received: : 2
Received: : 1
Received: : 1
.
.
.
Received: : 1
Received: : 1
Received: : 1
^C
</syntaxhighlight>

Hit CTRL-C to stop testing. In this example, no errors were reported.

===Usage Example. Test asynchronous IO using the '''FASYNC''' mode===

Perform the test on device <code>/dev/ttyS1</code>

<syntaxhighlight lang="text">
root@som9g20:/tmp# ./serial_test /dev/ttyS1 -f
Testing on /dev/ttyS1 using FASYNC
Received SIGIO signal.
: : 21
Received SIGIO signal.
: : 11
Received SIGIO signal.
: : 6
Received SIGIO signal.
: : 2
Received SIGIO signal.
: : 1
Received SIGIO signal.
: : 1
Received SIGIO signal.
: : 1
.
.
.
Received SIGIO signal.
: : 1
Received SIGIO signal.
: : 1
Received SIGIO signal.
: : 1
^C
</syntaxhighlight>

Hit CTRL-C to stop testing. In this example, no errors were reported.

==Summary==

The <code>serial</code> C example project application performs an asynchronous IO test on the specified serial device using either '''poll''' or '''FASYNC''' mode.

Example pthread demo

2022-11-30T19:21:39Z

Nperkins:

{{todo|SEOKWREV;(12.11.13-12:03->JG+);(12.11.13-17:25->MD-);(12.12.13-11:25->JG+);(12.31.13-12:45->MD+);(04.07.14-09:50->BS+);(04.10.14-11:00->BS+)|Jgreene|project=oe 4,oe 5,jg,md,SEOKWREV,mg,bs}}

{{#seo:
|title=pthread demo
|titlemode=append
|keywords=pthread,pthread example
|description=This is a guide to the <code>pthread_demo</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>pthread_demo</code> C example project included in the EMAC OE SDK.

This is a simple pthreads example application. A single thread is created to generate random data that is read by a specified number of reader threads.

The term ''pthread'' refers to [http://en.wikipedia.org/wiki/PThread POSIX Threads], a [http://en.wikipedia.org/wiki/POSIX POSIX] standard for threads.

The <code>pthread_demo</code> project builds one executable: <code>p_thread_demo</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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==

The <code>pthread_demo</code> project is an example of multithreaded code for generating and interacting with an arbitrary number of ''pthreads''. Within the '''pthread_demo.c''' C source file can be found demonstrations of how to, specifically: 
*Create pthreads, line 90.
*Write to pthreads, line 141.
*Read from pthreads, line 127.
*Terminate and clean up after pthreads, line 119.

===Hardware Requirements===

The <code>pthread_demo</code> C example project has no special hardware requirements. It should run just fine on any system for which the project files can be successfully compiled.

===Using <code>pthread_demo</code>===

./pthread_demo n
where '''n''' is the number of threads

===Usage Example===

<syntaxhighlight lang="text">
root@PPCE7:/tmp# ./pthread_demo 3
generating new random data
generating new random data
reader: count = 0, data = 693451072
generating new random data
reader: count = 1, data = 1195545710
generating new random data
reader: count = 2, data = 462104121
</syntaxhighlight>

==Usage and Behavior for Ipac-9x25 Examples==

The <code>p_hello</code> project is an example of multithreaded code for generating and interacting with an arbitrary number of ''pthreads''. Within the '''p_hello.c''' C source file can be found demonstrations using the '''pthread''' library.

===Using <code>p_hello</code>===

./p_hello n
where '''n''' is the number of threads

===Usage Example===

<syntaxhighlight lang="text">
root@PPCE7:/tmp# ./p_hello 3
Hello from node 0
Hello from node 1
Hello from node 2
</syntaxhighlight>

==Summary==

The <code>pthread_demo</code> C example project demonstrates how to use pthreads. For another example of pthread usage see [[Example pthread hello]].

Example i2c test

2022-11-30T19:21:00Z

Nperkins:

{{todo|Buggy (11.14.13-13:25->JG+);(11.14.13-15:45->MD-);(01.30.14-16:20->BS+);(01.30.14-18:30->MD-);(11.10.2015-12:50->MD+)|Brian Serrano|project=oe 4,oe 5,md,Buggy,bs}}

This is a guide to the <code>i2c_test</code> example project included in the EMAC OE SDK.

<code>I²C</code> is a two wire serial interface used to connect to a variety of sensor and I/O devices. The interface uses only two bi-directional open-drain I/Os, Serial Data Line (SDA) and Serial Clock (SCL), to communicate to devices based on an address encoded within the data transmission. SDA is a data signal which sends and receives serially transmitted data. SCL is a clock signal which is used to determine when to latch data from the SDA line.

This procedure provides an overview of how to compile and run the <code>i2c_test</code> C example project. This is an example test interface for reading/writing to the Linux <code>I²C</code> device interface. It is only relevant if the <code>I²C</code> device interface is enabled and an external <code>I²C</code> device is connected to the bus. It assumes familiarity with the C programming language and is intended to be used by experienced programmers who are looking to learn the EMAC SDK.

For more information about the protocol see the following page: http://www.nxp.com/documents/user_manual/UM10204.pdf

The <code>i2c_test</code> project builds one executable: <code>i2c_test</code>.
== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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 ==
=== Hardware Requirements ===

The <code>i2c_test</code> C example project will run on any EMAC carrier board which has an <code>I²C</code> interface (see also the [[EMAC_I²C_Programming | EMAC I²C Programming]] page).

===Using i2c_test===

The <code>i2c_test</code> program is executed from the console. If using the iPac9x25 it takes an optional argument which is the string representing the device path. By default, "/dev/i2c-1" is set, but if another device path needs to be used, append that to the command.

{{cli |./i2c_test <optional device_path>}}

A menu will appear in the terminal:

{{clop}}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
</nowiki>
{{closp}}

Select a function (a,b,c,d,e) to test or q to quit. You will be prompted for read, write and register values as appropriate. Test results will be displayed in the terminal.

==== Test Options ====

* '''Set Slave Address''' Press the ''A'' key to select the Set slave address function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> a

Enter the slave address (in hex): 48

Calling i2c_set_slave(3, 0x48)
i2c_set_slave reports success
</nowiki>
{{closp}}

The slave address receives the clock and responds when addressed by the master.

This function is to set the slave address of the <code>I²C</code> device. This only need to be done once to initialize the address and then each time that a new device is addressed.

* '''Write byte to register''' Press the ''B'' key to select the Write byte to register function, then press ''Enter''
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> b

Enter a byte to write (in hex): aa
Enter a register value to write (in hex): 01

Calling i2c_write_cmd(3, 0x1, 0xAA)
i2c_write_cmd reports success
</nowiki>
{{closp}}

This function uses the Linux <code>write</code> system call to write one byte to the selected register on the <code>I²C</code> device. 

* '''Write 2 bytes to register''' Press the ''C'' key to select the Write 2 bytes to register function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> c

Enter a 2 byte number to write (in hex): aabb
Enter a register value to write (in hex): 01

Calling i2c_write_cmd2(3, 0x1, 0xAABB)
i2c_write_cmd2 reports success
</nowiki>
{{closp}}

This function uses the same system call as the previous option, but writes 2 bytes to a register instead of just one.

* ''' Read byte from register ''' Press the ''D'' key to select the Read byte from register function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> d

Enter a register value to read from (in hex): bb

Calling i2c_read_reg(3, (__u8 *)&val, 0xBB)
i2c_read_reg reports success
Read value 0xB
</nowiki>
{{closp}}

This function uses the Linux <code>read</code> system call to read a byte to the selected register on the <code>I²C</code> device.

* '''Read 2 bytes from register''' Press the ''E'' key to select the Read 2 bytes from register function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> e

Enter a register value to read from (in hex): bbcc

Calling i2c_read_reg2(3, &val, 0xBBCC)
i2c_read_reg2 reports success
Read value 0xB0B
</nowiki>
{{closp}}

This function uses the same system call as the previous option, but shifts to the right.

The <code>i2c_test</code> example writes a byte to a selected register. The register then reads the byte, shifts the byte 8 bits to the right and then reads the address to the selected register on the <code>I²C</code> device. 

*'''Quit''' Press the ''Q'' key to quit out of the <code>i2c_test</code> example, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> q
Quiting...
</nowiki>
{{closp}}

This function exits you out of the <code>i2c_test</code> example on the <code>I²C</code> device.


== Real-World Example ==
=== Hardware Requirements ===
The <code>i2c_test</code> C Real-World example project will be running on an EMAC SOM-210ES carrier board. This example will be communicating with the RTC clock on the SOM-3517M.

For more information about the RTC Clock see the following page for the data sheet: http://www.nxp.com/documents/data_sheet/PCA8565.pdf

=== Using Real-World Example i2c_test ===

Just like before, the <code>i2c_test</code> program is executed from the console. It takes no parameters.

{{cli |./i2c_test}}

A menu will appear in the terminal:
{{clop}}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
</nowiki>
{{closp}}

==== Test Options ====

* '''Set Slave Address''' Press the ''A'' key to select the Set slave address function, then press ''Enter''.

The RTC Clock slave address in binary is 1010001 (58 in Hexadecimal).

{{note | The slave address must be shifted to the right one bit. }}

{{clop}}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> a

Enter the slave address (in hex): 28

Calling i2c_set_slave(3, 0x48)
i2c_set_slave reports success
</nowiki>
{{closp}}

== Summary ==

The <code>i2c_test</code> C example project writes and reads bytes to a selected register on the <code>I²C</code> device.

Example hello

2022-11-30T19:20:38Z

Nperkins:

{{todo|SEOKWREV (01.02.14-14:09->JG+);(01.02.14-14:30->MD+);(01.02.14-16:15->MG+);(04.04.14-15:40->BS+)|Jgreene|project=oe 4,oe 5,jg,md,SEOKWREV,mg,bs}}

{{#seo:
|title=Example hello
|titlemode=append
|keywords=Example hello,Using hello,EMAC C example project
|description=This is a guide to the <code>hello</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>hello</code> C example project included in the EMAC OE SDK.

This is a basic "hello world" project.

The <code>hello</code> project builds one executable: <code>hello</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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==

===Hardware Requirements===

The <code>hello</code> C example project will run on any system for which it can be compiled.

===Using <code>hello</code>===

The <code>hello</code> program is executed from the console. It takes no parameters.

<code>./hello</code>

The program prints a ''hello'' message to the console.

===Usage Example===

<syntaxhighlight lang="console">
root@som9g20:/tmp# ./hello
Hello EMAC OE!
</syntaxhighlight>

==Summary==

The <code>hello</code> C example project is your basic "hello world" project.

Example getkey

2022-11-30T19:20:24Z

Nperkins:

{{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,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.
}}
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'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>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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==

===Hardware Requirements===

To use the '''getkey''' program requires the following hardware.

* A [http://www.emacinc.com/som/som150es.htm SOM-150ES carrier board] (Available from EMAC). 
* A compatible SoM for that carrier board ([http://www.emacinc.com/products/system_on_module/SoM-9260M SOM-9260M], [http://www.emacinc.com/som/som9G20.htm SOM-9G20M] and [http://www.emacinc.com/som/som9x25.htm SOM-9X25] are all compatible and available from EMAC). 
* A compatible keypad ([http://www.emacinc.com/sbc_microcontroller_addons.htm Available from EMAC], refer to item# E20-21 or E020-25. [https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&ved=0CCsQFjAA&url=http%3A%2F%2Fwww.in2tec.com%2Flib%2Fdownloadfile.php%3Ffilename%3D4000_series_keypads_datasheet.pdf%26loc%3Ddocuments%2F%26ct%3Dpdf&ei=Wf-MUrGxO-nEyQGggoGgCg&usg=AFQjCNEQxIaiH6-gx6uTq4O66o1YVDunZw&bvm=bv.56643336,d.aWc Datasheet]).

[[File:Som150 with keypad.JPG | 500px ]] 
SOM-150ES carrier board with keypad

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

Plug the keypad into the HDR5 KEYPAD header of the SOM-150ES Carrier Board. 
[[File:Example getkey howtopluginthekeypad 0.png|500px]]

Ensure that '''pin 0''' of the keypad's ribbon cable is lined up with '''pin 2''' on the header. 
[[File:Example getkey howtopluginthekeypad 1.png|500px]]

===The Keypad Matrix File===

The keypad matrix file specifies associations between keypad-keys and characters. For each key in the keypad's grid of keys we specify a character in a grid of characters.

        [[File:Example_getkey_minimalkeypad.png|200px]]           [[File: Example_getkey_matrixfile.png|150px]]

In this example we see an E020-21 keypad on the left and an example keypad matrix file (<code>Key-E020-21</code>, included in the project) opened in a text editor on the right. The character matrix may be freely edited to suit.

====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 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.

        [[File:Matrix encoding.png]]

Thus, when a key is pressed, we get a corresponding integer value on the header. 
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. 
'''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===

The '''getkey''' program is controlled from the console via command line parameters. You can specify the keypad device node, specify the keypad matrix file (see notes on the [http://wikidev.emacinc.com/wiki/Example_getkey#The_Keypad_Matrix_File keypad matrix file], above), display the current matrix in the console and test individual character-key associations.

<code>./getkey [-d device -b -g -s file]</code>

;-d:Specify the keypad device node. The default is <code>/dev/keypad</code>
;-b:Test an individual key-character association (via "read blocking"). The program will sleep until a key on the keypad is pressed, then output that key's character to the console.
;-g:Outputs the current keypad matrix (see notes on the [http://wikidev.emacinc.com/wiki/Example_getkey#The_Keypad_Matrix_File keypad matrix file], above) to the console.
;-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.

===Usage Example. Mapping a Keypad Device Node to a Keypad Matrix File===

<code>./getkey -d /dev/keypad0 -s /path/to/this/file/Key-E020-21</code>

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===

<code>./getkey -d /dev/keypad0 -b</code>

The program will wait until a key is pressed on the keypad. When a key is pressed it will display the character associated with that pressed key, as specified in the keypad matrix file (see notes on the [http://wikidev.emacinc.com/wiki/Example_getkey#The_Keypad_Matrix_File keypad matrix file], above).

For example:
<syntaxhighlight lang="console">
root@som9g20:/tmp# ./getkey -d /dev/keypad0 -b
5
root@som9g20:/tmp#
</syntaxhighlight>
In this case, the '''5''' key on the keypad was pressed.

===Usage Example. Displaying the Character Matrix Presently Associated with the Keypad===

<code>./getkey -d /dev/keypad0 -g</code>

The program will display the character matrix (see notes on the [http://wikidev.emacinc.com/wiki/Example_getkey#The_Keypad_Matrix_File keypad matrix file], above) presently associated with the keypad at <code>/dev/keypad0''</code>.

<syntaxhighlight lang="console">
root@som9g20:/tmp# ./getkey -d /dev/keypad0 -g
1 2 3 C
4 5 6 D
7 8 9 E
A 0 B F
root@som9g20:/tmp#
</syntaxhighlight>
The character matrix displayed here is that of the <code>Key-E020-21</code> file.

==Summary==

The <code>getkey</code> example C project demonstrates how to use a keypad with a SoM150ES carrier board.

Example fbench

2022-11-30T19:19:59Z

Nperkins:

{{todo|SEOKWREV (12.03.13-14:18->JG+);(12.04.13-03:15->MD-);(12.04.13-13:56->JG+);(12.10.13-00:10->MD+);(01.03.13-18:41->MW+);(01.03.14-18:55->MD+);(04.02.14-17:00->BS+);(04.10.14-13:45->BS+)|Jgreene|project=oe 4,oe 5,jg,md,SEOKWREV,mw,bs}}

{{#seo:
|title=Example fbench
|titlemode=append
|keywords=Floating Point Operation,Floating Benchmark,Floating Point Unit
|description=This is a guide to the <code>fbench</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>fbench</code> C example project included in the EMAC OE SDK.

The project contains a floating point benchmark which tests the accuracy and speed of floating point operations on the target systems. The testing application utilizes floating point intensive ray tracing and Fast Fourier Transform algorithms to stress the processor. This project contains excerpts from the <code>fbench</code> project by John Walker of Fourmilab. See [http://www.fourmilab.ch/fbench/ John Walker's '''Floating Point Benchmarks''' project homepage] for more information.

The <code>fbench</code> project builds two executables: <code>fbench</code> and <code>ffbench</code>.

<code>fbench</code> is a trigonometry intensive floating point benchmark. It is a complete optical design raytracing algorithm without the user interface.

<code>ffbench</code> is a Fast Fourier Transform benchmark. It loops through a fast Fourier transform of a square matrix of complex numbers, reverses the transform and then checks the results.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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==

===Hardware Requirements===

The <code>fbench</code> project is intended for use on C implementations that define <code>int</code> as 32 bits or longer and permit allocation and direct addressing of arrays larger than one megabyte.

===Using fbench===

The <code>fbench</code> program is executed from the console. It takes a single optional parameter.

<code>./fbench <itercount></code>

Where <itercount> specifies the number of iterations to be performed, with 1,000 being the default. 
For archival purposes you'll want to use a value slightly higher than 1,000.

====Usage Example====

<syntaxhighlight lang="text">
root@som9g20:/tmp# ./fbench 2000
Ready to begin John Walker's floating point accuracy
and performance benchmark. 2000 iterations will be made.

Measured run time in seconds should be divided by 2
to normalise for reporting results. For archival results,
adjust iteration count so the benchmark runs about five minutes.

Press return to begin benchmark:
</syntaxhighlight>

After <code>fbench</code> has finished it prompts the user to stop the timer (by pressing return).

<syntaxhighlight lang="console">
Stop the timer:
</syntaxhighlight>

Press return...

<syntaxhighlight lang="console">
No errors in results.
</syntaxhighlight>

...and <code>fbench</code> reports that no errors were found in the floating point operations.

====A Note on Suspicious Systems====

The default functionality as described above is for systems that can be trusted to be reliable. When working with a system that is suspected of having issues, <code>fbench</code> can be compiled with <code>ACCURACY</code> defined. This will generate a version that executes as an infinite loop, performs the ray trace and checks the results on every pass. All incorrect results will be reported. It will keep running until it is stopped manually (using, for instance, CTRL-C).

===Using ffbench===

The <code>ffbench</code> program is executed from the console. It takes no parameters.

./ffbench

====Usage Example====

<syntaxhighlight lang="console">
root@som9g20:/tmp# ./ffbench
20 passes. No errors in results.
</syntaxhighlight>

It runs until it is finished and reports what it discovered. In this case it performed 20 passes (the default, specified in code) and found no errors. 
The time that it takes for this benchmark to run is an indicator of the performance of the board running it. When running it from a Bash shell, the execution time can be measured thusly:
<code>time ./fbench</code>

==Summary==

The <code>fbench</code> floating point benchmark C example tests the speed and accuracy of your floating point operations, and is interactive by default. The <code>ffbench</code> example, on the other hand, is non-interactive by default and can be readily used both for benchmarking a board's floating point performance and to test the accuracy of its FPU.

Example can

2022-11-30T19:18:24Z

Nperkins:

{{#seo:
|title=Example can
|titlemode=append
|keywords=Example can,Using can,EMAC C example project
|description=This is a guide to the <code>casn</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>can</code> C example project included in the EMAC OE SDK.

A Controller Area Network (CAN bus) is a robust bus standard for in-vehicle networks. Originally designed for use in the automotive industry, CAN allows micro-controllers and devices to communicate through a message-based protocol with device priority and is used in many different applications to this day.

This project serves as a demonstration of using the CAN bus.

The <code>can</code> project builds one executable: <code>can</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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==

===Hardware Requirements===

It should run just fine on any device with a CAN interface. You will need:
* Two devices with a CAN interface

===Using <code>can</code>===

The <code>can</code> program is executed from the console. Requires either the argument "send" or "receive"

<code>./can [send/recieve]</code>

The program will wait for data payload to be received (argument: "receive") through CAN or send data payload (argument: "send"), 8 random hex bytes, through CAN. The payload will then be printed on the receive end.

===Usage Example===
Prepare Device 1 to receive:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
.
</syntaxhighlight>
Send Data from Device 2:
<syntaxhighlight lang="console">
root@somimx6ul:~# ./can send
root@somimx6ul:~#
</syntaxhighlight>
Device 1 received:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
<0x001> [8] 87 5a 6a 37 7a 94 a4 01
root@ipac9x25:~#
</syntaxhighlight>

===Usage Example for iPac9x25===
You must first go into code and change the ifname to the name of your can port. The default example will use "can0".
Prepare Device 1 to receive:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
.
</syntaxhighlight>
Send Data from Device 2:
<syntaxhighlight lang="console">
root@somimx6ul:~# ./can send <data>
root@somimx6ul:~#
</syntaxhighlight>
Device 1 received:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
<0x001> [8] 87 5a 6a 37 7a 94 a4 01
root@ipac9x25:~#
</syntaxhighlight>

==Summary==

The <code>can</code> C example project demonstrates the use of the CAN bus.

Example SPI test

2022-10-14T17:28:27Z

Nperkins:

{{todo|Buggy (2.21.14-17:40->BS+);(2.24.14-13:00->MD-)(2.28.14-17:48->BS+)(03.10.14-13:30->MD-)(08.27.14-16:55->BS+)(09.09.14-17:20->MD-)(09.10.14-17:00->BS+)(09.13.14-21:40->MD+) |Brian Serrano|project=oe 4,md,Complete,bs}}

This is a guide to the <code>spi_test</code> example project included in the EMAC OE SDK.

The <code>SPI</code> protocol works in a master/slave setup. The master is responsible for sending the clock pulses. At each clock pulse, data will be sent and received. The rising or the falling clock edge will be used to synchronize the transfer depending on the CPOL setting.

<code>SPI</code> devices have a slave select pin. Every device will share the <code>MISO</code> (Master Input Slave Output), <code>MOSI</code> (Master Output Slave Input), and <code>Clock</code> pins, but each device will have its own slave select pin (also know as chip select). The slave select pin is used to set one device to be active on the bus while deactivating the rest. Theoretically, this means a virtually unlimited number of devices can be used on the same <code>SPI</code> bus; in practice, the number is limited by a number of factors, such as required transaction rates, mechanisms (GPIO pins, bus expanders, etc) available for selecting specific devices, and physical routing constraints. The slave select pin can be active high or active low depending on the device.

The <code>SPI</code> protocol defines four signal lines, but only requires three to operate properly. The fourth line is only required if you have more than one device on the SPI bus; otherwise, you can hard-wire the chip select pin of the only device on the <code>SPI</code> bus so that it is always selected.

This procedure provides an overview of how to compile and run the <code>spi_test</code> C example project. This is an example test interface for sending a transaction to an EMAC <code>SPI</code> device interface. It is only relevant if the EMAC <code>SPI</code> device interface is enabled for an external <code>SPI</code> device that is connected to the bus. It assumes familiarity with the C programming language and is intended to be used by experienced programmers who are looking to learn the EMAC SDK.

For more information about the <code>SPI</code> protocol, see the following page: http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus

The <code>spi_test</code> project builds one executable: <code>spi_test</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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]].

== Usage and Behavior ==
===Hardware Requirements===

The <code>spi_test</code> C example project will run on any EMAC carrier board which has an <code>SPI</code> interface (see also the [http://wikidev.emacinc.com/wiki/EMAC_SPI_Programming EMAC SPI Programming] page).

=== Using indexed_atod_test ===

The <code>indexed_atod_test</code> program is executed from the console. It takes two parameters.

root@emac-oe~:$ ./indexed_atod_test device channel

:* <code>device</code>: Name of the <code>indexed_atod</code> device node.
:* <code>channel</code>: Number of <code>indexed_atod</code> channels to be displayed.

{|style="margin: 0 auto;"
| [[File:Potentiometer3.jpg|left|thumb|300px|alt=A potentiometer circuit.|Figure 1: Potentiometer Circuit]]
| [[File:Hdr8_chan1.jpg|right|thumb|250px|alt=HDR8 Analog I/O|Figure 2: HDR8 ANALOG I/O]] 
|}

This example command was run on an EMAC SoM-150ES carrier board with a SoM-9G20M. This test uses a potentiometer for input to the A/D. You will be communicating with the mcp3208 chip, which is an 8-channel 12-bit A/D converter with SPI Serial Interface. Figure 1 provides a potentiometer test circuit for help on connection to the SoM-150ES carrier board. A circuit like this is recommended for familiarizing oneself with the A/D code before connecting the actual device to be measured by the A/D.

Before running the command in the terminal, you will need to connect the potentiometer to the carrier board as diagrammed. Figure 2 shows where to connect the potentiometer on Header 8 of the SoM-150ES. You will be focusing on CARR_ANL_1 for this example.

Turn the potentiometer counter-clockwise as far as it goes. You'll see the results when you run the command below. Test results will be displayed in the terminal.

<syntaxhighlight lang=console>
root@emac-oe~:$ ./indexed_atod_test /dev/mcp3208-gpio 4
[0] = 83
[1] = 4094
[2] = 61
[3] = 267
</syntaxhighlight>

The results that are displayed from the terminal show channel 1 analog value at 4094. All the other results are just noise coming from the mcp3208 chip. This noise can be virtually eliminated by grounding the unused A/D inputs.

For the second example, turn the potentiometer clockwise as far as it goes. You'll see how channel 1 results will change when running the command below. Test results will be displayed in the terminal.

<syntaxhighlight lang=console>
root@emac-oe~:$ ./indexed_atod_test /dev/mcp3208-gpio 4
[0] = 62
[1] = 0
[2] = 10
[3] = 95
</syntaxhighlight>

Here, the results show channel 1 analog value at zero. Your results may vary, depending on the characteristics of your potentiometer and the ADC noise present. You can alter the value by turning the potentiometer to different positions.

[[File:Hdr8_chan6.jpg|center|thumb|250px|alt=HDR8 Analog I/O|Figure 3: HDR8 ANALOG I/O]] 

Before doing example 3, you'll want to put the wiper (B) wire on pin 9 of the SoM-150ES carrier board. Figure 3 shows that pin 9 is CARR_ANL_6. Turn the potentiometer counter-clockwise about half way. You will see how the values on channel 6 will change when running the command below. Test results will be displayed in the terminal.

<syntaxhighlight lang=console>
root@emac-oe~:$ ./indexed_atod_test /dev/mcp3208-gpio 7
[0] = 53
[1] = 0
[2] = 56
[3] = 0
[4] = 29
[5] = 43
[6] = 2044
</syntaxhighlight>

The results show the channel 6 analog value at 2044, which is about half way (4095/2). You can change any of the channels value with the potentiometer as long as you put the wiper pin on the channel you want to change.

Due to ADC noise, you may see the values fluctuate slightly from one run to the next. This is normal behavior. This fluctuation can be more severe with some potentiometers than it is with others; some potentiometers are more prone to picking up noise. The noise will also be more severe with longer wires, due to transmission line effects. Eliminating noise is typically the greatest challenge in high resolution A/D conversion (especially at 18 bit and above), so you should expect to see some noise when performing an informal test such as this.

==Updates for iPac9x25==
In order to run these examples on the board, either follow the schematic from figure 4 or use part MIKROE-304.
{|style="margin: 0 auto;"
|[[File:Spi Test Schematic.png|thumb|Figure 4: Schematic used to set up spi test for iPac9x25]]
 
|}

== Summary ==
The <code>indexed_atod_test</code> C example project demonstrates how to use a 12 bit A/D converter chip (mcp3208) with SPI Serial Interface. <code>SPI</code> is simply a way to send data from device to device in a serial fashion (bit by bit). <code>SPI</code> provides good support for communication with peripheral devices that are accessed intermittently.

Example SPI test

2022-10-14T17:27:46Z

Nperkins:

{{todo|Buggy (2.21.14-17:40->BS+);(2.24.14-13:00->MD-)(2.28.14-17:48->BS+)(03.10.14-13:30->MD-)(08.27.14-16:55->BS+)(09.09.14-17:20->MD-)(09.10.14-17:00->BS+)(09.13.14-21:40->MD+) |Brian Serrano|project=oe 4,md,Complete,bs}}

This is a guide to the <code>spi_test</code> example project included in the EMAC OE SDK.

The <code>SPI</code> protocol works in a master/slave setup. The master is responsible for sending the clock pulses. At each clock pulse, data will be sent and received. The rising or the falling clock edge will be used to synchronize the transfer depending on the CPOL setting.

<code>SPI</code> devices have a slave select pin. Every device will share the <code>MISO</code> (Master Input Slave Output), <code>MOSI</code> (Master Output Slave Input), and <code>Clock</code> pins, but each device will have its own slave select pin (also know as chip select). The slave select pin is used to set one device to be active on the bus while deactivating the rest. Theoretically, this means a virtually unlimited number of devices can be used on the same <code>SPI</code> bus; in practice, the number is limited by a number of factors, such as required transaction rates, mechanisms (GPIO pins, bus expanders, etc) available for selecting specific devices, and physical routing constraints. The slave select pin can be active high or active low depending on the device.

The <code>SPI</code> protocol defines four signal lines, but only requires three to operate properly. The fourth line is only required if you have more than one device on the SPI bus; otherwise, you can hard-wire the chip select pin of the only device on the <code>SPI</code> bus so that it is always selected.

This procedure provides an overview of how to compile and run the <code>spi_test</code> C example project. This is an example test interface for sending a transaction to an EMAC <code>SPI</code> device interface. It is only relevant if the EMAC <code>SPI</code> device interface is enabled for an external <code>SPI</code> device that is connected to the bus. It assumes familiarity with the C programming language and is intended to be used by experienced programmers who are looking to learn the EMAC SDK.

For more information about the <code>SPI</code> protocol, see the following page: http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus

The <code>spi_test</code> project builds one executable: <code>spi_test</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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]].

== Usage and Behavior ==
===Hardware Requirements===

The <code>spi_test</code> C example project will run on any EMAC carrier board which has an <code>SPI</code> interface (see also the [http://wikidev.emacinc.com/wiki/EMAC_SPI_Programming EMAC SPI Programming] page).

=== Using indexed_atod_test ===

The <code>indexed_atod_test</code> program is executed from the console. It takes two parameters.

root@emac-oe~:$ ./indexed_atod_test device channel

:* <code>device</code>: Name of the <code>indexed_atod</code> device node.
:* <code>channel</code>: Number of <code>indexed_atod</code> channels to be displayed.

{|style="margin: 0 auto;"
| [[File:Potentiometer3.jpg|left|thumb|300px|alt=A potentiometer circuit.|Figure 1: Potentiometer Circuit]]
| [[File:Hdr8_chan1.jpg|right|thumb|250px|alt=HDR8 Analog I/O|Figure 2: HDR8 ANALOG I/O]] 
|}

This example command was run on an EMAC SoM-150ES carrier board with a SoM-9G20M. This test uses a potentiometer for input to the A/D. You will be communicating with the mcp3208 chip, which is an 8-channel 12-bit A/D converter with SPI Serial Interface. Figure 1 provides a potentiometer test circuit for help on connection to the SoM-150ES carrier board. A circuit like this is recommended for familiarizing oneself with the A/D code before connecting the actual device to be measured by the A/D.

Before running the command in the terminal, you will need to connect the potentiometer to the carrier board as diagrammed. Figure 2 shows where to connect the potentiometer on Header 8 of the SoM-150ES. You will be focusing on CARR_ANL_1 for this example.

Turn the potentiometer counter-clockwise as far as it goes. You'll see the results when you run the command below. Test results will be displayed in the terminal.

<syntaxhighlight lang=console>
root@emac-oe~:$ ./indexed_atod_test /dev/mcp3208-gpio 4
[0] = 83
[1] = 4094
[2] = 61
[3] = 267
</syntaxhighlight>

The results that are displayed from the terminal show channel 1 analog value at 4094. All the other results are just noise coming from the mcp3208 chip. This noise can be virtually eliminated by grounding the unused A/D inputs.

For the second example, turn the potentiometer clockwise as far as it goes. You'll see how channel 1 results will change when running the command below. Test results will be displayed in the terminal.

<syntaxhighlight lang=console>
root@emac-oe~:$ ./indexed_atod_test /dev/mcp3208-gpio 4
[0] = 62
[1] = 0
[2] = 10
[3] = 95
</syntaxhighlight>

Here, the results show channel 1 analog value at zero. Your results may vary, depending on the characteristics of your potentiometer and the ADC noise present. You can alter the value by turning the potentiometer to different positions.

[[File:Hdr8_chan6.jpg|center|thumb|250px|alt=HDR8 Analog I/O|Figure 3: HDR8 ANALOG I/O]] 

Before doing example 3, you'll want to put the wiper (B) wire on pin 9 of the SoM-150ES carrier board. Figure 3 shows that pin 9 is CARR_ANL_6. Turn the potentiometer counter-clockwise about half way. You will see how the values on channel 6 will change when running the command below. Test results will be displayed in the terminal.

<syntaxhighlight lang=console>
root@emac-oe~:$ ./indexed_atod_test /dev/mcp3208-gpio 7
[0] = 53
[1] = 0
[2] = 56
[3] = 0
[4] = 29
[5] = 43
[6] = 2044
</syntaxhighlight>

The results show the channel 6 analog value at 2044, which is about half way (4095/2). You can change any of the channels value with the potentiometer as long as you put the wiper pin on the channel you want to change.

Due to ADC noise, you may see the values fluctuate slightly from one run to the next. This is normal behavior. This fluctuation can be more severe with some potentiometers than it is with others; some potentiometers are more prone to picking up noise. The noise will also be more severe with longer wires, due to transmission line effects. Eliminating noise is typically the greatest challenge in high resolution A/D conversion (especially at 18 bit and above), so you should expect to see some noise when performing an informal test such as this.

==Updates for iPac9x25==
In order to run these examples on the board, either follow the schematic from figure 4 or use part MIKROE-304.
{|style="margin: 0 auto;"
| [[File:Potentiometer3.jpg|left|thumb|300px|alt=A potentiometer circuit.|Figure 1: Potentiometer Circuit]]
[[File:Spi Test Schematic.png|thumb|Schematic used to set up spi test for iPac9x25]]
 
|}

== Summary ==
The <code>indexed_atod_test</code> C example project demonstrates how to use a 12 bit A/D converter chip (mcp3208) with SPI Serial Interface. <code>SPI</code> is simply a way to send data from device to device in a serial fashion (bit by bit). <code>SPI</code> provides good support for communication with peripheral devices that are accessed intermittently.

File:Spi Test Schematic.png

2022-10-14T17:27:16Z

Nperkins:

Schematic to be used to set up spi test on iPac9x25.

Example i2c test

2022-10-14T17:08:47Z

Nperkins: /* Using i2c_test */

{{todo|Buggy (11.14.13-13:25->JG+);(11.14.13-15:45->MD-);(01.30.14-16:20->BS+);(01.30.14-18:30->MD-);(11.10.2015-12:50->MD+)|Brian Serrano|project=oe 4,oe 5,md,Buggy,bs}}

This is a guide to the <code>i2c_test</code> example project included in the EMAC OE SDK.

<code>I²C</code> is a two wire serial interface used to connect to a variety of sensor and I/O devices. The interface uses only two bi-directional open-drain I/Os, Serial Data Line (SDA) and Serial Clock (SCL), to communicate to devices based on an address encoded within the data transmission. SDA is a data signal which sends and receives serially transmitted data. SCL is a clock signal which is used to determine when to latch data from the SDA line.

This procedure provides an overview of how to compile and run the <code>i2c_test</code> C example project. This is an example test interface for reading/writing to the Linux <code>I²C</code> device interface. It is only relevant if the <code>I²C</code> device interface is enabled and an external <code>I²C</code> device is connected to the bus. It assumes familiarity with the C programming language and is intended to be used by experienced programmers who are looking to learn the EMAC SDK.

For more information about the protocol see the following page: http://www.nxp.com/documents/user_manual/UM10204.pdf

The <code>i2c_test</code> project builds one executable: <code>i2c_test</code>.
== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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]].
== Usage and Behavior ==
=== Hardware Requirements ===

The <code>i2c_test</code> C example project will run on any EMAC carrier board which has an <code>I²C</code> interface (see also the [[EMAC_I²C_Programming | EMAC I²C Programming]] page).

===Using i2c_test===

The <code>i2c_test</code> program is executed from the console. If using the iPac9x25 it takes an optional argument which is the string representing the device path. By default, "/dev/i2c-1" is set, but if another device path needs to be used, append that to the command.

{{cli |./i2c_test <optional device_path>}}

A menu will appear in the terminal:

{{clop}}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
</nowiki>
{{closp}}

Select a function (a,b,c,d,e) to test or q to quit. You will be prompted for read, write and register values as appropriate. Test results will be displayed in the terminal.

==== Test Options ====

* '''Set Slave Address''' Press the ''A'' key to select the Set slave address function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> a

Enter the slave address (in hex): 48

Calling i2c_set_slave(3, 0x48)
i2c_set_slave reports success
</nowiki>
{{closp}}

The slave address receives the clock and responds when addressed by the master.

This function is to set the slave address of the <code>I²C</code> device. This only need to be done once to initialize the address and then each time that a new device is addressed.

* '''Write byte to register''' Press the ''B'' key to select the Write byte to register function, then press ''Enter''
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> b

Enter a byte to write (in hex): aa
Enter a register value to write (in hex): 01

Calling i2c_write_cmd(3, 0x1, 0xAA)
i2c_write_cmd reports success
</nowiki>
{{closp}}

This function uses the Linux <code>write</code> system call to write one byte to the selected register on the <code>I²C</code> device. 

* '''Write 2 bytes to register''' Press the ''C'' key to select the Write 2 bytes to register function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> c

Enter a 2 byte number to write (in hex): aabb
Enter a register value to write (in hex): 01

Calling i2c_write_cmd2(3, 0x1, 0xAABB)
i2c_write_cmd2 reports success
</nowiki>
{{closp}}

This function uses the same system call as the previous option, but writes 2 bytes to a register instead of just one.

* ''' Read byte from register ''' Press the ''D'' key to select the Read byte from register function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> d

Enter a register value to read from (in hex): bb

Calling i2c_read_reg(3, (__u8 *)&val, 0xBB)
i2c_read_reg reports success
Read value 0xB
</nowiki>
{{closp}}

This function uses the Linux <code>read</code> system call to read a byte to the selected register on the <code>I²C</code> device.

* '''Read 2 bytes from register''' Press the ''E'' key to select the Read 2 bytes from register function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> e

Enter a register value to read from (in hex): bbcc

Calling i2c_read_reg2(3, &val, 0xBBCC)
i2c_read_reg2 reports success
Read value 0xB0B
</nowiki>
{{closp}}

This function uses the same system call as the previous option, but shifts to the right.

The <code>i2c_test</code> example writes a byte to a selected register. The register then reads the byte, shifts the byte 8 bits to the right and then reads the address to the selected register on the <code>I²C</code> device. 

*'''Quit''' Press the ''Q'' key to quit out of the <code>i2c_test</code> example, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> q
Quiting...
</nowiki>
{{closp}}

This function exits you out of the <code>i2c_test</code> example on the <code>I²C</code> device.


== Real-World Example ==
=== Hardware Requirements ===
The <code>i2c_test</code> C Real-World example project will be running on an EMAC SOM-210ES carrier board. This example will be communicating with the RTC clock on the SOM-3517M.

For more information about the RTC Clock see the following page for the data sheet: http://www.nxp.com/documents/data_sheet/PCA8565.pdf

=== Using Real-World Example i2c_test ===

Just like before, the <code>i2c_test</code> program is executed from the console. It takes no parameters.

{{cli |./i2c_test}}

A menu will appear in the terminal:
{{clop}}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
</nowiki>
{{closp}}

==== Test Options ====

* '''Set Slave Address''' Press the ''A'' key to select the Set slave address function, then press ''Enter''.

The RTC Clock slave address in binary is 1010001 (58 in Hexadecimal).

{{note | The slave address must be shifted to the right one bit. }}

{{clop}}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> a

Enter the slave address (in hex): 28

Calling i2c_set_slave(3, 0x48)
i2c_set_slave reports success
</nowiki>
{{closp}}

== Summary ==

The <code>i2c_test</code> C example project writes and reads bytes to a selected register on the <code>I²C</code> device.

Example can

2022-10-14T17:08:20Z

Nperkins: /* Usage Example for Ipac-9x25 */

{{#seo:
|title=Example can
|titlemode=append
|keywords=Example can,Using can,EMAC C example project
|description=This is a guide to the <code>casn</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>can</code> C example project included in the EMAC OE SDK.

A Controller Area Network (CAN bus) is a robust bus standard for in-vehicle networks. Originally designed for use in the automotive industry, CAN allows micro-controllers and devices to communicate through a message-based protocol with device priority and is used in many different applications to this day.

This project serves as a demonstration of using the CAN bus.

The <code>can</code> project builds one executable: <code>can</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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]].

==Usage and Behavior==

===Hardware Requirements===

It should run just fine on any device with a CAN interface. You will need:
* Two devices with a CAN interface

===Using <code>can</code>===

The <code>can</code> program is executed from the console. Requires either the argument "send" or "receive"

<code>./can [send/recieve]</code>

The program will wait for data payload to be received (argument: "receive") through CAN or send data payload (argument: "send"), 8 random hex bytes, through CAN. The payload will then be printed on the receive end.

===Usage Example===
Prepare Device 1 to receive:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
.
</syntaxhighlight>
Send Data from Device 2:
<syntaxhighlight lang="console">
root@somimx6ul:~# ./can send
root@somimx6ul:~#
</syntaxhighlight>
Device 1 received:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
<0x001> [8] 87 5a 6a 37 7a 94 a4 01
root@ipac9x25:~#
</syntaxhighlight>

===Usage Example for iPac9x25===
You must first go into code and change the ifname to the name of your can port. The default example will use "can0".
Prepare Device 1 to receive:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
.
</syntaxhighlight>
Send Data from Device 2:
<syntaxhighlight lang="console">
root@somimx6ul:~# ./can send <data>
root@somimx6ul:~#
</syntaxhighlight>
Device 1 received:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
<0x001> [8] 87 5a 6a 37 7a 94 a4 01
root@ipac9x25:~#
</syntaxhighlight>

==Summary==

The <code>can</code> C example project demonstrates the use of the CAN bus.

Example pthread demo

2022-10-14T17:06:27Z

Nperkins:

{{todo|SEOKWREV;(12.11.13-12:03->JG+);(12.11.13-17:25->MD-);(12.12.13-11:25->JG+);(12.31.13-12:45->MD+);(04.07.14-09:50->BS+);(04.10.14-11:00->BS+)|Jgreene|project=oe 4,oe 5,jg,md,SEOKWREV,mg,bs}}

{{#seo:
|title=pthread demo
|titlemode=append
|keywords=pthread,pthread example
|description=This is a guide to the <code>pthread_demo</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>pthread_demo</code> C example project included in the EMAC OE SDK.

This is a simple pthreads example application. A single thread is created to generate random data that is read by a specified number of reader threads.

The term ''pthread'' refers to [http://en.wikipedia.org/wiki/PThread POSIX Threads], a [http://en.wikipedia.org/wiki/POSIX POSIX] standard for threads.

The <code>pthread_demo</code> project builds one executable: <code>p_thread_demo</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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]].

==Usage and Behavior==

The <code>pthread_demo</code> project is an example of multithreaded code for generating and interacting with an arbitrary number of ''pthreads''. Within the '''pthread_demo.c''' C source file can be found demonstrations of how to, specifically: 
*Create pthreads, line 90.
*Write to pthreads, line 141.
*Read from pthreads, line 127.
*Terminate and clean up after pthreads, line 119.

===Hardware Requirements===

The <code>pthread_demo</code> C example project has no special hardware requirements. It should run just fine on any system for which the project files can be successfully compiled.

===Using <code>pthread_demo</code>===

./pthread_demo n
where '''n''' is the number of threads

===Usage Example===

<syntaxhighlight lang="text">
root@PPCE7:/tmp# ./pthread_demo 3
generating new random data
generating new random data
reader: count = 0, data = 693451072
generating new random data
reader: count = 1, data = 1195545710
generating new random data
reader: count = 2, data = 462104121
</syntaxhighlight>

==Usage and Behavior for Ipac-9x25 Examples==

The <code>p_hello</code> project is an example of multithreaded code for generating and interacting with an arbitrary number of ''pthreads''. Within the '''p_hello.c''' C source file can be found demonstrations using the '''pthread''' library.

===Using <code>p_hello</code>===

./p_hello n
where '''n''' is the number of threads

===Usage Example===

<syntaxhighlight lang="text">
root@PPCE7:/tmp# ./p_hello 3
Hello from node 0
Hello from node 1
Hello from node 2
</syntaxhighlight>

==Summary==

The <code>pthread_demo</code> C example project demonstrates how to use pthreads. For another example of pthread usage see [[Example pthread hello]].

Example i2c test

2022-10-14T16:59:44Z

Nperkins:

{{todo|Buggy (11.14.13-13:25->JG+);(11.14.13-15:45->MD-);(01.30.14-16:20->BS+);(01.30.14-18:30->MD-);(11.10.2015-12:50->MD+)|Brian Serrano|project=oe 4,oe 5,md,Buggy,bs}}

This is a guide to the <code>i2c_test</code> example project included in the EMAC OE SDK.

<code>I²C</code> is a two wire serial interface used to connect to a variety of sensor and I/O devices. The interface uses only two bi-directional open-drain I/Os, Serial Data Line (SDA) and Serial Clock (SCL), to communicate to devices based on an address encoded within the data transmission. SDA is a data signal which sends and receives serially transmitted data. SCL is a clock signal which is used to determine when to latch data from the SDA line.

This procedure provides an overview of how to compile and run the <code>i2c_test</code> C example project. This is an example test interface for reading/writing to the Linux <code>I²C</code> device interface. It is only relevant if the <code>I²C</code> device interface is enabled and an external <code>I²C</code> device is connected to the bus. It assumes familiarity with the C programming language and is intended to be used by experienced programmers who are looking to learn the EMAC SDK.

For more information about the protocol see the following page: http://www.nxp.com/documents/user_manual/UM10204.pdf

The <code>i2c_test</code> project builds one executable: <code>i2c_test</code>.
== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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]].
== Usage and Behavior ==
=== Hardware Requirements ===

The <code>i2c_test</code> C example project will run on any EMAC carrier board which has an <code>I²C</code> interface (see also the [[EMAC_I²C_Programming | EMAC I²C Programming]] page).

===Using i2c_test===

The <code>i2c_test</code> program is executed from the console. If using the Ipac-9x25 it takes an optional argument which is the string representing the device path. By default, "/dev/i2c-1" is set, but if another device path needs to be used, append that to the command.

{{cli |./i2c_test <optional device_path>}}

A menu will appear in the terminal:

{{clop}}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
</nowiki>
{{closp}}

Select a function (a,b,c,d,e) to test or q to quit. You will be prompted for read, write and register values as appropriate. Test results will be displayed in the terminal.

==== Test Options ====

* '''Set Slave Address''' Press the ''A'' key to select the Set slave address function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> a

Enter the slave address (in hex): 48

Calling i2c_set_slave(3, 0x48)
i2c_set_slave reports success
</nowiki>
{{closp}}

The slave address receives the clock and responds when addressed by the master.

This function is to set the slave address of the <code>I²C</code> device. This only need to be done once to initialize the address and then each time that a new device is addressed.

* '''Write byte to register''' Press the ''B'' key to select the Write byte to register function, then press ''Enter''
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> b

Enter a byte to write (in hex): aa
Enter a register value to write (in hex): 01

Calling i2c_write_cmd(3, 0x1, 0xAA)
i2c_write_cmd reports success
</nowiki>
{{closp}}

This function uses the Linux <code>write</code> system call to write one byte to the selected register on the <code>I²C</code> device. 

* '''Write 2 bytes to register''' Press the ''C'' key to select the Write 2 bytes to register function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> c

Enter a 2 byte number to write (in hex): aabb
Enter a register value to write (in hex): 01

Calling i2c_write_cmd2(3, 0x1, 0xAABB)
i2c_write_cmd2 reports success
</nowiki>
{{closp}}

This function uses the same system call as the previous option, but writes 2 bytes to a register instead of just one.

* ''' Read byte from register ''' Press the ''D'' key to select the Read byte from register function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> d

Enter a register value to read from (in hex): bb

Calling i2c_read_reg(3, (__u8 *)&val, 0xBB)
i2c_read_reg reports success
Read value 0xB
</nowiki>
{{closp}}

This function uses the Linux <code>read</code> system call to read a byte to the selected register on the <code>I²C</code> device.

* '''Read 2 bytes from register''' Press the ''E'' key to select the Read 2 bytes from register function, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> e

Enter a register value to read from (in hex): bbcc

Calling i2c_read_reg2(3, &val, 0xBBCC)
i2c_read_reg2 reports success
Read value 0xB0B
</nowiki>
{{closp}}

This function uses the same system call as the previous option, but shifts to the right.

The <code>i2c_test</code> example writes a byte to a selected register. The register then reads the byte, shifts the byte 8 bits to the right and then reads the address to the selected register on the <code>I²C</code> device. 

*'''Quit''' Press the ''Q'' key to quit out of the <code>i2c_test</code> example, then press ''Enter''.
{{clop | indent=1 }}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> q
Quiting...
</nowiki>
{{closp}}

This function exits you out of the <code>i2c_test</code> example on the <code>I²C</code> device.


== Real-World Example ==
=== Hardware Requirements ===
The <code>i2c_test</code> C Real-World example project will be running on an EMAC SOM-210ES carrier board. This example will be communicating with the RTC clock on the SOM-3517M.

For more information about the RTC Clock see the following page for the data sheet: http://www.nxp.com/documents/data_sheet/PCA8565.pdf

=== Using Real-World Example i2c_test ===

Just like before, the <code>i2c_test</code> program is executed from the console. It takes no parameters.

{{cli |./i2c_test}}

A menu will appear in the terminal:
{{clop}}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
</nowiki>
{{closp}}

==== Test Options ====

* '''Set Slave Address''' Press the ''A'' key to select the Set slave address function, then press ''Enter''.

The RTC Clock slave address in binary is 1010001 (58 in Hexadecimal).

{{note | The slave address must be shifted to the right one bit. }}

{{clop}}<nowiki>
Select a function to test:
a: Set slave address
b: Write byte to register
c: Write 2 bytes to register
d: Read byte from register
e: Read 2 bytes from register
q: Quit
>> a

Enter the slave address (in hex): 28

Calling i2c_set_slave(3, 0x48)
i2c_set_slave reports success
</nowiki>
{{closp}}

== Summary ==

The <code>i2c_test</code> C example project writes and reads bytes to a selected register on the <code>I²C</code> device.

Example can

2022-10-14T16:55:33Z

Nperkins:

{{#seo:
|title=Example can
|titlemode=append
|keywords=Example can,Using can,EMAC C example project
|description=This is a guide to the <code>casn</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>can</code> C example project included in the EMAC OE SDK.

A Controller Area Network (CAN bus) is a robust bus standard for in-vehicle networks. Originally designed for use in the automotive industry, CAN allows micro-controllers and devices to communicate through a message-based protocol with device priority and is used in many different applications to this day.

This project serves as a demonstration of using the CAN bus.

The <code>can</code> project builds one executable: <code>can</code>.

== Opening, Building and Uploading the Project Files ==

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 information on this method, please see [[Using EMAC OE SDK Example Projects]].

====EMAC SDK 5.X====

For information on opening the project from within QtCreator, please see [[Getting_Started_With_Qt_Creator#Adding_Source_Files | QtCreator: Adding Source Files]]. Then, follow [[Getting Started With Qt Creator]] for information on how to build, upload and execute the example.

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]].

==Usage and Behavior==

===Hardware Requirements===

It should run just fine on any device with a CAN interface. You will need:
* Two devices with a CAN interface

===Using <code>can</code>===

The <code>can</code> program is executed from the console. Requires either the argument "send" or "receive"

<code>./can [send/recieve]</code>

The program will wait for data payload to be received (argument: "receive") through CAN or send data payload (argument: "send"), 8 random hex bytes, through CAN. The payload will then be printed on the receive end.

===Usage Example===
Prepare Device 1 to receive:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
.
</syntaxhighlight>
Send Data from Device 2:
<syntaxhighlight lang="console">
root@somimx6ul:~# ./can send
root@somimx6ul:~#
</syntaxhighlight>
Device 1 received:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
<0x001> [8] 87 5a 6a 37 7a 94 a4 01
root@ipac9x25:~#
</syntaxhighlight>

===Usage Example for Ipac-9x25===
You must first go into code and change the ifname to the name of your can port. The default example will use "can0".
Prepare Device 1 to receive:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
.
</syntaxhighlight>
Send Data from Device 2:
<syntaxhighlight lang="console">
root@somimx6ul:~# ./can send <data>
root@somimx6ul:~#
</syntaxhighlight>
Device 1 received:
<syntaxhighlight lang="console">
root@ipac9x25:~# ./can receive
<0x001> [8] 87 5a 6a 37 7a 94 a4 01
root@ipac9x25:~#
</syntaxhighlight>

==Summary==

The <code>can</code> C example project demonstrates the use of the CAN bus.