View source for Example Xenomai Timer

{{todo| FinalDraft (10.06.2015-12:58->KY+)|Klint Youngmeyer| project=OE 5.0,KY,FinalDraft }}
{{#seo:
|title=Example xenomai timer
|titlemode=append
|keywords=Example timer,Xenomai, Timer C,Software Timer
|description=This is a guide to the <code>xenomai-timer</code> C example project included in the EMAC OE SDK.
}}
This is a guide to the <code>xenomai-timer</code> C example project included in the EMAC OE SDK.

This project demonstrates how to build the real-time software timer.

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

== Building and Running the Project Files ==

===Hardware Requirements===

The <code>xenomai-timer</code> C example project will run on an i586 system with a real-time Xenomai kernel.

=== Building the Project ===

There are some options for building this example project: Qt Creator or CMake.

==== Qt Creator ====

This process will show how to build the project using Qt Creator. For further information on using Qt Creator, please see [[Getting_Started_With_Qt_Creator |Getting Started With Qt Creator]].

# Open Qt Creator using the "EMAC IDE" button on the Ubuntu sidebar. 
# Click the "Example" button on the left of the page. This will bring up a list of all included examples. 
# Select the "Xenomai Timer" icon. The example wizard will now request the build directory for the project. It is not recommended to use the default location. The following is a reasonable location on an EMAC LDC.
#:{{clo}}/home/developer/Projects/xenomai-timer{{clos}}
# The next window will prompt to run CMake. Click the "Run CMake" button.
# Click "Finish" (Note: This project may not build for the Desktop kit, unless the Xenomai libraries are installed for your system.)
# Click the "Projects" icon in the left column, then click "Add Kit" and select "OE 5.x x86".
# The default build location is fine, click Next.
# Enter the following into the Arguments field, then click "Run CMake."
#:{{clo}}-DARCH:STRING=x86{{clos}}
# Click Finish.
# Ensure that the "OE 5.x x86" kit is selected by clicking the computer icon on the lower left, then click Build (the hammer icon).
# Add the target device to the Qt Creator devices by following the instructions on [[Getting_Started_With_Qt_Creator#Getting_Started_with_Qt_Creator|this page]], starting at point 9.
# Click the Run button on the bottom left (green arrow).

=== CMake ===

This process will show how to build the project using CMake.

# Navigate to the Projects directory.
#:{{cli | username=developer | hostname=ldc | cd ~/Projects }}
# Copy the xenomai-timer example to the current directory.
#:{{cli | username=developer | hostname=ldc | cp -r /opt/emac/5.0/sysroots/x86_64-emacsdk-linux/usr/demos/EMAC-Examples/xenomai-timer/ . }}
# Change directory to the project directory.
#:{{cli | username=developer | hostname=ldc | cd xenomai-timer }}
# Create build directory for cross-compilation, then change directory into it.
#:{{cli | username=developer | hostname=ldc | mkdir xenomai-timer-build-OE5-x86 }}
#:{{cli | username=developer | hostname=ldc | cd xenomai-timer-build-OE5-x86 }}
# Run CMake.
#:{{cli | username=developer | hostname=ldc | 1 = cmake .. -DARCH:STRING=x86 }}
# Build the project.
#:{{cli | username=developer | hostname=ldc | make }}
# Copy the executable to the target board. Substitute the IP address <code>10.0.2.41</code> with the IP address of your target board.
#:{{cli | username=developer | hostname=ldc | scp timer root@10.0.2.41:/tmp }}
#Open a terminal on the target board, using SSH, serial, or a dedicated screen and keyboard.
# Navigate to the /tmp directory.
#:{{cli |  hostname=x86 | cd /tmp }}
# Run the program.
#:{{cli |  hostname=x86 | ./timer }}


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

The <code>timer</code> program is executed from the console.

 <code>./timer</code>

The program will continue running until it is manually halted with a CTRL-C.


==Summary==

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