Getting Started with the EMAC OE SDK - Revision history

Mgloff at 15:28, 23 July 2021

2021-07-23T15:28:31Z

Btisler: Reviewed and updated using the Update 2019 version and a few additions of links for clarity and flow

2020-09-08T19:03:22Z

Reviewed and updated using the Update 2019 version and a few additions of links for clarity and flow

Mgloff at 20:47, 11 February 2019

2019-02-11T20:47:31Z

Dsojka at 21:14, 12 September 2017

2017-09-12T21:14:30Z

Mgloff at 19:45, 30 May 2017

2017-05-30T19:45:30Z

Awichmann at 16:18, 8 June 2016

2016-06-08T16:18:00Z

Mdean: Fixed formatting issue.

2015-11-16T16:53:24Z

Fixed formatting issue.

Mdean: Fixed syntax highlighting issue.

2015-11-16T16:48:49Z

Fixed syntax highlighting issue.

Mdean: Tweaked indent level on one cli block.

2015-11-04T22:07:53Z

Tweaked indent level on one cli block.

Kyoungmeyer at 21:26, 3 November 2015

2015-11-03T21:26:35Z

@@ Line 192: / Line 192: @@
 ===== Target Board Compiling =====
-To compile for the target board, you must <code>source</code> the <code>environment-setup-armv5e-emac-linux-gnueabi</code> file.
+To compile for the target board, you must <code>source</code> the <code>environment-setup-armv5e-emac-linux-gnueabi</code> file in /opt/emac/5.X where 5.X is the SDK version.
-{{cli | username=developer | hostname=ldc | source /opt/emac/5.1/environment-setup-armv5e-emac-linux-gnueabi }}
+{{cli | username=developer | hostname=ldc | source /opt/emac/5.X/environment-setup-armv5e-emac-linux-gnueabi }}
 Once you are in the directory with the source file, enter the following command:

@@ Line 13: / Line 13: @@
 <span style="background:#00FF00;color:#FF0000;font-size:300%"></span>
 The EMAC OE SDK is distributed with a set of example projects intended to demonstrate how to use the EMAC OE toolchain and libraries. This page demonstrates the process of compiling an example project and running it on the target machine. Also, it provides a straightforward guide to the essential steps you need to follow to get started with cross compiling a simple program with gcc and running the program on your embedded machine.
 __TOC__
@@ Line 21: / Line 22: @@
 {{:Templateimpl:using | initials=BS | title=Getting Started with the EMAC OE SDK | desc=Basic tutorial for using the EMAC OE SDK. | project=OE 5.0 }}
 === Installing EMAC SDK ===
 === Connecting to a Target Board ===
@@ Line 57: / Line 64: @@
 === Basic Compiling ===
-The two subsections below show the two common options for how to compile source code. The first subsection demonstrates how to use the EMAC [[ #CMake_Compiling| CMake ]] tool, while the second subsection demonstrates how to compile c code [[ #Manual_Compiling | manually ]].
+The two subsections below show the two common options for how to compile source code. The first subsection demonstrates how to use the EMAC [[ #CMake_Compiling| CMake ]] tool, while the second subsection demonstrates how to compile c code [[ #Manual_Compiling | manually ]]. Another helpful link if you are looking to create a new project with CMake: [[ Creating_a_New_EMAC_OE_SDK_Project_with_CMake | Creating a New EMAC OE SDK Project with CMake ]]
 ==== CMake Compiling ====
@@ Line 144: / Line 151: @@
 The <code> make </code> command creates the target executable in the <code> hello_emac-build-arm </code> directory.
-* Now copy the executable to the target board. For information on copying the executable file, see the [[ #Transferring_Files | Transferring Files ]] section.
+* Now copy the executable to the target board. Use any of the options listed under the [[ #Transferring_Files | Transferring Files ]] section.
 </cl>
 <br />
@@ Line 184: / Line 193: @@
 To compile for the target board, you must <code>source</code> the <code>environment-setup-armv5e-emac-linux-gnueabi</code> file.
-{{cli | username=developer | hostname=ldc | source /opt/emac/5.X/environment-setup-armv5e-emac-linux-gnueabi }}
+{{cli | username=developer | hostname=ldc | source /opt/emac/5.1/environment-setup-armv5e-emac-linux-gnueabi }}
 Once you are in the directory with the source file, enter the following command:
@@ Line 274: / Line 283: @@
 {{:Templateimpl:whatnext | initials=BS | title=Getting Started with the EMAC OE SDK | desc=Basic tutorial for using the EMAC OE SDK. | project=OE 5.0 }}
-* [[Getting_Started_With_Qt_Creator |Getting Started With Qt Creator]]
+* [[ Creating_a_New_EMAC_OE_SDK_Project_with_CMake | Creating a New EMAC OE SDK Project with CMake ]]
-* [[System_Log_In | System Log In]]
+* [[EMAC_Example_Projects | EMAC Example Projects]]
 * [[Serial_Connections | Serial Connections ]]
 * [[Network_Connections | Network_Connections ]]
 * [[Remote_Debugging_EMAC_OE_SDK_Projects_with_gdbserver | Remote Debugging EMAC OE SDK Projects with gdbserver ]]
 * [[Linux_Filesystem_Organization | Linux Filesystem Organization]]
-* [[Creating_a_New_EMAC_OE_SDK_Project_with_CMake | Creating a Project with CMake ]]
+* [[System_Log_In | System Log In]]
 * [[System_Logging | System Logging ]]

@@ Line 69: / Line 69: @@
 Navigate to the directory where the project will be located. Then run the CMake new project script.
 {{clo}}
-{{clio | username=developer | hostname=ldc | pwd=~/projects | oe_init_project -n hello.c }}
+{{clio | username=developer | hostname=ldc | pwd=~ |cd projects }}
 If desired, please enter a name for this project, otherwise press Enter to use the default: hello_emac <br />

@@ Line 20: / Line 20: @@
 <!-- /*********************************************************************************************************/ -->
 {{:Templateimpl:using | initials=BS | title=Getting Started with the EMAC OE SDK | desc=Basic tutorial for using the EMAC OE SDK. | project=OE 5.0 }}
 === Installing EMAC SDK ===

@@ Line 15: / Line 15: @@
 __TOC__
 <!-- /*********************************************************************************************************/ -->
@@ Line 36: / Line 23: @@
 === Installing EMAC SDK ===
-This is the EMAC Apt Repository, which hosts installation files for EMAC provided tools built for 64 bit Ubuntu 12.04 LTS and 14.04 LTS. To use this repository, a source for it must be added to your apt sources, and the key for the repository must be added to your machine. The steps below outline how to do this.
+[[Installing_EMAC_OE_5.0_SDK | SDK Install]]
 === Connecting to a Target Board ===
-A machine running EMAC OE Linux can be connected to through a serial port or through a network cable.  EMAC OE Linux allows users to log in via getty, and SSH (Secure Shell). A getty can be accessed via a serial connection (through a console) while SSH utilizes a network connection.  More information on establishing a physical connection to a board is available on the [[Serial_Connections |Serial Connections]] and [[Network_Connections |Network Connections]] page.
+Primarily a board is connected to through it's debug serial port. If it also connected to a network and the IP address is known, ssh can be used to connect as well. More information on establishing a physical connection to a board is available on the [[Serial_Connections |Serial Connections]] and [[Network_Connections |Network Connections]] page.
 The next step after establishing a physical connection to the board is logging in.  For more information visit the [[System_Log_In | System Log In]] page.
@@ Line 92: / Line 40: @@
 === Transferring Files ===
-The command line syntax for transferring a file using the SSH protocol is <code>scp file user@host:/directory</code>. SCP, or Secure Copy, is a way of securely transferring files between a local and remote host. For example, to send the file ''example.text'' to the <code>/home</code> directory of a system with the IP address 10.0.6.221, enter the following command:
+The command line syntax for transferring a file using the SSH protocol is <code>scp file user@host:/directory</code>. SCP, or Secure Copy, is a way of securely transferring files between a local and remote host. For example, to send the file ''example.text'' to the <code>/usr/bin</code> directory of a system with the IP address 10.0.6.221, enter the following command:
-{{cli | username=developer | hostname=ldc | scp example.text root@10.0.6.221:/home/ }}
+{{cli | username=developer | hostname=ldc | scp example.text root@10.0.6.221:/usr/bin/ }}
-Alternatively, you can leave off the path after the colon if you want the file to go directly into the home directory.
+Alternatively, you can leave off the path after the colon if you want the file to go directly into the root user's home directory.
 {{cli | username=developer | hostname=ldc | scp example.text root@10.0.6.221: }}
 === Remote Execution ===
@@ Line 202: / Line 148: @@
 <br />{{note|In these examples we are using the Ipac-9x25 board. Your board's processor's architecture will determine which file needs to be sourced. These files come from the EMAC SDK toolchain.}}
-Create a file called hello.c using a text editor such as vi, vim, nano, or gedit. Then copy and paste the source code from the [[ #Hello_World_System_Log_Example | Hello World System Log Example ]] section in the text editor of your choice.
+Create a file called hello.c using a text editor such as vi, nano, or gedit. Then copy and paste the source code from the [[ #Hello_World_System_Log_Example | Hello World System Log Example ]] section in the text editor of your choice.
 Once you've created and saved the file with the source code, use the following syntax to compile the program called hello.c:
@@ Line 256: / Line 202: @@
 <br />
 <br />
 === Remote Debugging ===
@@ Line 339: / Line 269: @@
 {{:Templateimpl:whatnext | initials=BS | title=Getting Started with the EMAC OE SDK | desc=Basic tutorial for using the EMAC OE SDK. | project=OE 5.0 }}
 * [[System_Log_In | System Log In]]
 * [[Serial_Connections | Serial Connections ]]

@@ Line 171: / Line 171: @@
 The source code file generated by the script (''hello.c'') contains a basic Hello World style program.
-The ''README'' file contains more information on using ''CMake'' with the EMAC 5.0 SDK.
+The ''README'' file contains more information on using ''CMake'' with the EMAC 5.X SDK.
 The Desktop Build Directory (''hello_emac-build'') contains the executable ''hello_emac'', the ''Makefile'', and various cache files.  These were automatically created by CMake and by the build system, and can be recreated at any time.
@@ Line 233: / Line 233: @@
 To compile for the target board, you must <code>source</code> the <code>environment-setup-armv5e-emac-linux-gnueabi</code> file.
-{{cli | username=developer | hostname=ldc | source /opt/emac/5.0/environment-setup-armv5e-emac-linux-gnueabi }}
+{{cli | username=developer | hostname=ldc | source /opt/emac/5.X/environment-setup-armv5e-emac-linux-gnueabi }}
 Once you are in the directory with the source file, enter the following command:

@@ Line 42: / Line 42: @@
 #:'''For Ubuntu 12.04 LTS:'''
 #:
-#:{{cli | username=developer | hostname=ldc | echo "deb http://apt.emacinc.com/ubuntu precise non-free" > /etc/apt/sources.list.d/emac.list }}
+#:{{cli | username=developer | hostname=ldc | <nowiki>echo "deb http://apt.emacinc.com/ubuntu precise non-free" > /etc/apt/sources.list.d/emac.list</nowiki> }}
 #:
 #:'''For Ubuntu 14.04 LTS:'''
 #:
-#:{{cli | username=developer | hostname=ldc | echo "deb http://apt.emacinc.com/ubuntu trusty non-free" > /etc/apt/sources.list.d/emac.list }}
+#:{{cli | username=developer | hostname=ldc | <nowiki>echo "deb http://apt.emacinc.com/ubuntu trusty non-free" > /etc/apt/sources.list.d/emac.list</nowiki> }}
 #:
 # Add the EMAC Apt Key:
 #:
-#:{{cli | username=developer | hostname=ldc | sudo sh -c 'wget -O - http://apt.emacinc.com/packages.emac.key {{!}} apt-key add -' }}
+#:{{cli | username=developer | hostname=ldc | <nowiki>sudo sh -c 'wget -O - http://apt.emacinc.com/packages.emac.key</nowiki> {{!}} apt-key add -' }}
 #:
 #:'''Note that the 'O' above is a capital letter 'o', not a zero.'''

@@ Line 73: / Line 73: @@
 </li>
 <li> Install desired EMAC packages:
-{{cli | indent=3 | username=developer | hostname=ldc | apt-get install emac-sdk }}
+{{cli | indent=1 | username=developer | hostname=ldc | apt-get install emac-sdk }}
 </li>
 </ol>