Difference between revisions of "Example Xenomai Timer"

From wiki.emacinc.com
Jump to: navigation, search
(Created page with "{{ subst:Pgtempl | initials={{subst::Templateimpl:getinitials}} | project=OE 5.0 | title=Example xenomai timer | desc=This is a guide to the <code>xenomai-timer</code> C examp...")
 
Line 1: Line 1:
−
{{todo| NotStarted (10.06.2015-12:58->KY+)| Kyoungmeyer | project=OE 5.0,KY }}
+
{{todo| FinalDraft (10.06.2015-12:58->KY+)|Klint Youngmeyer| project=OE 5.0,KY }}
 
{{#seo:
 
{{#seo:
 
|title=Example xenomai timer
 
|title=Example xenomai timer
 
|titlemode=append
 
|titlemode=append
−
|keywords=
+
|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.
 
|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.
−
<!-- /****************************************  Page Description Text  ****************************************/ -->
 
−
<!-- /*********************************************************************************************************/ -->
 
−
<span style="background:#00FF00;color:#FF0000;font-size:300%">'''''Put the page description text here.'''''</span>
 
  
−
__TOC__
+
The <code>timer</code> project builds one executable: <code>timer</code>.
  
−
<!-- /*********************************************************************************************************/ -->
+
== Building and Running the Project Files ==
−
<!-- /***************************************** Background Information ****************************************/ -->
 
−
<!-- /*********************************************************************************************************/ -->
 
−
{{:Templateimpl:bg | initials=KY | title=Example xenomai timer | desc=This is a guide to the <code>xenomai-timer</code> C example project included in the EMAC OE SDK. | project=OE 5.0 }}
 
  
−
<!-- /*********************************************************************************************************/ -->
+
===Hardware Requirements===
−
<!-- /*****************************************  General Information  *****************************************/ -->
 
−
<!-- /*********************************************************************************************************/ -->
 
−
{{:Templateimpl:geninfo | initials=KY | title=Example xenomai timer | desc=This is a guide to the <code>xenomai-timer</code> C example project included in the EMAC OE SDK. | project=OE 5.0 }}
 
  
−
<!-- /*********************************************************************************************************/ -->
+
The <code>xenomai-timer</code> C example project will run on an i586 system with a real-time Xenomai kernel.
−
<!-- /*****************************************  Using/Working With  ******************************************/ -->
 
−
<!-- /*********************************************************************************************************/ -->
 
−
{{:Templateimpl:using | initials=KY | title=Example xenomai timer | desc=This is a guide to the <code>xenomai-timer</code> C example project included in the EMAC OE SDK. | project=OE 5.0 }}
 
  
−
<!-- /*********************************************************************************************************/ -->
+
=== Building the Project ===
−
<!-- /*****************************************      Examples        *****************************************/ -->
 
−
<!-- /*********************************************************************************************************/ -->
 
−
{{:Templateimpl:examples | initials=KY | title=Example xenomai timer | desc=This is a guide to the <code>xenomai-timer</code> C example project included in the EMAC OE SDK. | project=OE 5.0 }}
 
  
−
<!-- /*********************************************************************************************************/ -->
+
There are some options for building this example project: Qt Creator or CMake.
−
<!-- /******************************************    Conclusion      ******************************************/ -->
 
−
<!-- /*********************************************************************************************************/ -->
 
−
{{:Templateimpl:conclusion | initials=KY | title=Example xenomai timer | desc=This is a guide to the <code>xenomai-timer</code> C example project included in the EMAC OE SDK. | project=OE 5.0 }}
 
  
−
<!-- /*********************************************************************************************************/ -->
+
==== Qt Creator ====
−
<!-- /******************************************  More Information  *****************************************/ -->
 
−
<!-- /*********************************************************************************************************/ -->
 
−
{{:Templateimpl:moreinfo | initials=KY | title=Example xenomai timer | desc=This is a guide to the <code>xenomai-timer</code> C example project included in the EMAC OE SDK. | project=OE 5.0 }}
 
−
*
 
  
−
{{:Templateimpl:whatnext | initials=KY | title=Example xenomai timer | desc=This is a guide to the <code>xenomai-timer</code> C example project included in the EMAC OE SDK. | project=OE 5.0 }}
+
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.

Revision as of 11:59, 6 October 2015

TODO: {{#todo: FinalDraft (10.06.2015-12:58->KY+)|Klint Youngmeyer|OE 5.0,KY}}

This is a guide to the xenomai-timer C example project included in the EMAC OE SDK.

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

The timer project builds one executable: timer.

Building and Running the Project Files

Hardware Requirements

The xenomai-timer 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.

  1. Open Qt Creator using the "EMAC IDE" button on the Ubuntu sidebar.
  2. Click the "Example" button on the left of the page. This will bring up a list of all included examples.
  3. 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.
    /home/developer/Projects/xenomai-timer
  4. The next window will prompt to run CMake. Click the "Run CMake" button.
  5. Click "Finish" (Note: This project may not build for the Desktop kit, unless the Xenomai libraries are installed for your system.)
  6. Click the "Projects" icon in the left column, then click "Add Kit" and select "OE 5.x x86".
  7. The default build location is fine, click Next.
  8. Enter the following into the Arguments field, then click "Run CMake."
    -DARCH:STRING=x86
  9. Click Finish.
  10. 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).
  11. Add the target device to the Qt Creator devices by following the instructions on this page, starting at point 9.
  12. Click the Run button on the bottom left (green arrow).

CMake

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

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


Using timer

The timer program is executed from the console. 

./timer

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


Summary

The timer C example project demonstrates how to use the xenomai timer.

Retrieved from "https://wiki.emacinc.com/index.php?title=Example_Xenomai_Timer&oldid=4730"