# root/documentation/ossie/user-guide-0.7.0/QuickStartGuide.tex@8050

Revision 8050, 4.2 KB (checked in by mcarrick, 5 years ago)

updating 0.7.0 version information and other minor changes

• Property svn:eol-style set to native
Line
1% ------------------------------------------------------------------
2%
3%   TITLE: OSSIE Quick Start Guide
4% AUTHORS: Matt Carrick
5% CREATED:
6% REVISED:
7%     URL: http://ossie.wireless.vt.edu/
8%
9% ------------------------------------------------------------------
10
11\section{Quick Start Guide}
12\label{section:quickstartguide}
13The following is a quick start guide. It is meant to be a concise introduction
14to OSSIE. While it assumes general computer
15knowledge, it tries not to assume extensive knowledge of or familiarity with Linux or
16OSSIE. The quick start guide is a compact version of much of the rest of
17the guide. If you are interested in more in-depth coverage, we recommend you
18fully read the pertinent sections of the guide.
19The rest of this document should be able answer more of the questions that may arise
20during installation and provide deeper insight into OSSIE. That
21said, here is a short walkthrough to get you experimenting with
22OSSIE in short order.
23
24\subsection{Using the OSSIE VMware Player Image}
25The VMware Player application is needed to run the OSSIE demonstration waveform
26using our VMware image.
27
30and install it. For detailed instructions, consult the VMWare Player User Guide~\cite{vmware:web}.
31
34When the download is complete, unzip the image to another directory. We
35recommend you keep the original zip file. It can serve as a useful backup
36should you want or need to start from a fresh install and might save
37time and bandwidth.
38
39Once the image is unpacked, boot it up in VMware Player. This quick start guide
40will walk you though the process of running OSSIE and our demonstration
41waveform. \describeossiedemo
42
43\subsection{Running the OSSIE Demonstration Waveform}
44\label{section:quickstartguide:ossiedemo}
45Once the OSSIE VMware image has booted up, open a
46terminal window by navigating to Applications$\to$System
47Tools$\to$Terminal. The first thing that needs to be started is the
48naming service. Type as root:
49%TODO: instructions on logging in as root
50\begin{lstlisting}[]
51 # omniNames.sh
52\end{lstlisting}
53
54%TODO: fix image to automagically start naming service
55
56The terminal should look like this:
57\begin{center}
58\includegraphics[scale=0.4]{figures/quickstart/omniNames.png}
59\end{center}
60
61The next service that needs to be started is the Node Booter. Open a new tab or
62a completely new terminal and type the commands in the listing below. You can
63press tab after the first couple of letters of a command, directory or
64filename to have it automatically completed, saving time and perhaps avoiding
65typos.
66\begin{lstlisting}[]
67 $cd /sdr/ 68$ nodeBooter -D -d nodes/default_GPP_node/DeviceManager.dcd.xml
69\end{lstlisting}
70
71The terminal should look like this:
72\begin{center}
73\includegraphics[scale=0.4]{figures/quickstart/nodeBooter.png}
74\end{center}
75
76Now load the waveform using wavLoader. In a third tab or terminal, type in:
77\begin{lstlisting}[]
78 $cd /sdr/waveforms/ossie_demo 79$ wavLoader.py ossie_demo_DAS.xml
80\end{lstlisting}
81
82The terminal should look similar to the following:
83\begin{center}
85\end{center}
86
87Select the first listing of the OSSIE demonstration waveform,\\
89\begin{lstlisting}[]
90 Selection: 1
91\end{lstlisting}
92
93The tab or terminal window in which nodeBooter was started should now contain
94the output of the demonstration waveform. The lines will update with output
95similar to this:
96\begin{verbatim}
97 RxDemo errors:  X  / 1024
98\end{verbatim}
99The X denotes the number of QPSK bit errors out of 1024 that have been detected
100by the RxDemo component.
101Here is an example output:
102\begin{center}
103\includegraphics[scale=0.4]{figures/quickstart/RxDemo.png}
104\end{center}
105
106Congratulations! You have just run the QPSK demonstration waveform for OSSIE
107version 0.7.0. From here you may be interested in learning how to create
108your own waveforms using the OSSIE Waveform Developer (OWD) described in
109Section~\ref{section:owd}.
110
111
Note: See TracBrowser for help on using the browser.