# Changeset 8281

Show
Ignore:
Timestamp:
09/10/08 01:48:14 (5 years ago)
Message:

General small fixes caught during proofreading.

Location:
documentation/ossie/user-guide-0.7.0
Files:
9 modified

Unmodified
Removed
• ## documentation/ossie/user-guide-0.7.0/ALFGuide.tex

r8280 r8281
8383\label{alf:tools:plot}
8484Right click on an existing {\it uses} port on the graphical interface and select
85 Plot'' in order to plot the data. Note that the data must be either of type
85Plot'' in order to plot data. The data must be either of type
8686{\tt complexShort} or type {\tt complexFloat} for this tool.
8787\begin{center}

9393\label{alf:tools:writetofile}
9494In order to write data to a file, right click on an existing {\it uses} port and
95 select {\tt write\_to\_file}. In the write to file window you may specify where
96 the data will be written. Click on the write packet'' button to write the
95select write\_to\_file.'' In the write to file window you may specify where
96the data will be written. Click on the Write Packet'' button to write the
9797last incoming packet to file.
9898

103103down menu (e.g., random''), or select File'' in order to specify a file to
104104read data from. The data will be sent when the Push Packet'' button is
105 pressed. Note that the data being sent will be of type {\tt complexShort}.
105pressed. The data being sent will be of type {\tt complexShort}.
106106
107107\subsubsection{The Speaker Tool}

115115The main toolbar of the ALF display contains buttons that allow you to toggle
116116the timing displays. In order to view the throughput of a port, right click on
117 the desired port and select get info.'' Note that the port must support
118 timing. This feature can be added when creating the component in OWD. Timing
117the desired port and select Get Info.'' Note that the port must support
118timing. This feature can be added when creating the component. Timing
119119support is available only for the custom\_ports and py\_comp component
120120generation options.  Currently no documentation exists for the custom\_ports

125125\label{alf:tools:connecttool}
126126On the main toolbar of the ALF display, to the right of the timing buttons, there
127 is a button to start the connect tool. To connect two ports, specify the uses
128 port on the left half of the connect tool display and specify the provides port
127is a button to start the connect tool. To connect two ports, specify the {\it uses}
128port on the left half of the connect tool display and specify the {\it provides} port
129129on the right side of the connect tool display. To specify a port, select the
130130appropriate waveform from the first drop-down menu. Once the waveform is

136136\subsubsection{The Automation Tool}
137137\label{alf:tools:automationtool}
138 The Automation Tool is a feature which allows aggregate waveforms to be built. Through the use of XML files, additional components can be added or removed while the waveform is running.
139
140 \subsubsection{Automation Tool Example}
141 \label{alf:tools:autotoolexample}
142 To start the tool, select the Connect Tool button on the main toolbar within ALF. This will display the Connect Tool window, which at the bottom has a path to an automation file and a Load Automation File button. Double click on a waveform in the Launch Waveform Applications panel in the main ALF window to start the waveform. Enter the full path to the XML file and select Load Automation File. For example run the {\tt pass\_data\_waveform}, enter the path {\tt /sdr/tools/alf/automationFileExamples/example1.xml}, and select Load Automation File.
138The Automation Tool is a feature which allows aggregate waveforms to be built. Through the use of XML files, additional components can be added or
139removed while the waveform is running. To start the tool, select the Connect Tool'' button on the main toolbar within ALF. This will display the
140Connect Tool window, which at the bottom has a path to an automation file and a Load Automation File'' button. Double click on a waveform in the
141Launch Waveform Applications panel in the main ALF window to start the waveform. Enter the full path to the XML file and select Load Automation
142File.'' For example, to run the {\tt pass\_data\_waveform}, enter the path {\tt /sdr/tools/alf/automationFileExamples/example1.xml}, and select
143Load Automation File.''
143144
144145This will bring up the Arbitrary Waveform Generator window. The AWG allows components to be added to the waveform through the Packet Headers box, and determines which kind of data will be sent to the components. In this example, the waveform has two consumers, labeled 1 and 2. These are components which can be installed and uninstalled through setting the appropriate packet headers. To send a packet to a consumer enter its number into the Packet Headers box, separated by commas. For example, to send two packets to consumer 1, and one to consumer 2, enter the following:

166167    <port>cshort_in</port>
167168\end{lstlisting}
168 The name of the consumer is "My first consumer" and it is designated 1, which means to send a packet to the consumer using the AWG the number 1 must be entered in the Packet Headers text box. The consumer is set to be installed at start up, denoted by the install\_at\_startup tag. If this was set as False, the consumer would only be installed when the first packet is pushed to it. The component is pass\_data, and the input port is defined as cshort\_in.
169The name of the consumer is My first consumer'' and it is designated 1, which means to send a packet to the consumer using the AWG the number 1
170must be entered in the Packet Headers text box. The consumer is set to be installed at start up, denoted by the install\_at\_startup tag. If this was
171set as False, the consumer would only be installed when the first packet is pushed to it. The component is {\tt pass\_data}, and the input port is
172defined as {\tt cshort\_in}.
169173
170174
• ## documentation/ossie/user-guide-0.7.0/HelpingWithDevelopment.tex

r6049 r8281
1515\subsection{Giving Feedback and Submitting Bugs}
1616The {\it ossie-discuss} mailing list and the \#ossie IRC channel on Freenode are
17 probably the methods of discussing and collaboratively solving end-user problems.
17probably the best methods of discussing and collaboratively solving end-user problems.
1818For development-oriented issues, Trac tickets and the {\it ossie-dev} mailing

2121mailing lists.
2222
23 \subsection{Making Contributions}
23\subsection{Contributing Code}
2424Contributions are heartily welcomed. The best way to get to know the developers
25 and really get involved is submit patches that fix bugs or add features.
26 Other work such as writing or revising documentation would also naturally be
27 appreciated. Patches can generally be sent to us through Trac or the mailing
25and really get involved is submit patches that fix bugs or add features. Patches can generally be sent to us through Trac or the mailing
2826list. Write access to the subversion repository can be given to contributors
2927who have proved their reliability.
3028
3129In order to make sure OSSIE stays open, we have licensed the source code under
32 GNU's General Public License Version 2 and the Lesser General Public License.
30the GNU General Public License Version 2 and the Lesser General Public License.
3331Contributions to the project must be made under these licenses. Also, the
3432preferred coding style is that devised for the Linux
• ## documentation/ossie/user-guide-0.7.0/Installation.tex

r8280 r8281
3838\label{section:installation:yum:ossierepo}
39 In order to install OSSIE via the YUM repository, you must first edit your '/etc/yum.conf' to
40 add the OSSIE repository to the YUM search list. In this example, we use 'nano', but you may use
39In order to install OSSIE via the YUM repository, you must first edit your /etc/yum.conf' to
40add the OSSIE repository to the YUM search list. In this example, we use nano', but you may use
4141whatever editor you wish (vim, emacs, etc).
4242\begin{lstlisting}[]

6565\end{lstlisting}
6666
67 Congratulations!  You should now have a fully-operable OSSIE installation!
67Congratulations!  You should now have a fully-operable OSSIE installation.
6868
6969\subsection{Installing OSSIE from Source}

116116Under the "Ubuntu Software" tab, make sure all of the boxes are selected which
117117have the following tags at the end: (main), (universe), (restricted), and (multiverse).
118 Then close the window and select "Reload" to update the package list.
118Then close the window and select Reload'' to update the package list.
119119
120120To update the list manually, open the source.list file:

369369\end{lstlisting}
370370
371 The {\tt build.py} script installs the core framework, components, devices and a few demonstration waveforms. This script should not be run as root. To install first exit out of root, move into the directory where the OSSIE 0.7.0 tarball has been unpacked and run the script:
371The {\tt build.py} script installs the core framework, components, devices and a few demonstration waveforms. This script should not be run as root.
372To install, first exit out of root, then move into the directory where the OSSIE 0.7.0 tarball has been unpacked and run the script:
372373
373374\begin{lstlisting}[]

411412\label{section:installation:javainstall}
412413Eclipse is written in Java, so you must have it installed to run Eclipse and OEF.
413 Install the full Java Software Development Kit (SDK) for best results. The GNU
414 GCC implementation of Java, GCJ, will not work and therefore Sun's JDK must be used
416
417 If installing OEF on Fedora 9, this step can be skipped as Java is already installed. However on other platforms this step may need to be performed.
414We recommend using Sun's Java Development Kit. As of this writing, the GNU Compiler for Java (GCJ) will not work.
415
416Fedora Core 9 comes with the Sun JDK pre-installed but older versions require manual installation. On other distributions it is advisable to use the
417package manager to manage the installation, if possible.
418418
419419\subsubsection{Installing Java on Older Versions of Fedora}

451451
452 Eclipse is distributed as a tar file that you install in a location of your choice. Pick a location that is appropriate for your platform and simply unpack the contents. There is no self-installer, just unpack the distribution. Do not install Eclipse in a directory that has spaces anywhere in its full path name.
452Eclipse is distributed as a tarball archive that you can unpack to location of your choice. Pick a location that is appropriate for your platform and
453simply unpack the contents. There is no self-installer, just unpack the distribution. Do not install Eclipse in a directory that has spaces anywhere
454in its full path name.
453455
454456\subsubsection{Installing OEF}
• ## documentation/ossie/user-guide-0.7.0/Introduction.tex

r8050 r8281
7676\subsubsection{The \#ossie IRC Channel}
7777\label{section:irc}
78 For those interested in real-time communication, an Internet Relay Chat channel
79 is great. The developers are not online at all times but the IRC channel also
80 allows users to help solve each others' problems. Our channel,
78Several OSSIE team members idle in an Internet Relay Chat to aid those interested in real-time communication.
79Our channel,
8180\href{irc://irc.freenode.net/\#ossie}{\#ossie}, is on the
8281\href{http://freenode.net/}{Freenode network}. To visit it, try clicking on the
• ## documentation/ossie/user-guide-0.7.0/OEFGuide.tex

r8280 r8281
7878\end{center}
7979
80 The waveform is completely defined and is ready to be run. Save the waveform by pressing CTRL+S or File : Save, which will also compile and install it to the {\tt /sdr/waveforms/} directory.
80The waveform should be completely defined and ready to be run. Save the waveform by pressing CTRL+S or File : Save, which will also compile and
81install it to the {\tt /sdr/waveforms/} directory.
8182
8283\subsection{Creating a New Component}

112 A property, the gain, will be added to the component so it can be set by a user when building a waveform. Add the property by selecting Add in the Properties panel. This will bring up the Property Editor window where multiple different parameters can be set for the property. For this example, enter gain for the Name, "Amplifier gain" for the Description and select Add Property to add it to the component.
113A property, the gain, will be added to the component so it can be set by a user when building a waveform. Add the property by selecting Add in the
114Properties panel. This will bring up the Property Editor window where various parameters can be set for the property. For this example,
115enter gain for the Name, Amplifier gain'' for the Description and select Add Property to add it to the component.
113116
114117\begin{center}

160163\begin{lstlisting}[]
161164$cd /path/to/OEF/workspace/component_name/ 162$ vim component_name.cpp
165$nano component_name.cpp 163166\end{lstlisting} 164167 210213You will need to edit {\tt MyComponent.spd.xml} before your Python 211214component will work properly. Find the XML tag below the tag {\tt <code 212 type="'Executable"'>}. By default the next tag is: 213 \begin{lstlisting}[] 214 <localfile name="'bin/MyComponent"'/>} 215type="Executable">}. By default the next tag is: 216\begin{lstlisting}[] 217 <localfile name="bin/MyComponent"/>} 215218\end{lstlisting} 216219This needs to be changed to: 217220\begin{lstlisting}[] 218 <localfile name="'bin/MyComponent/MyComponent.py"'/> 221 <localfile name="bin/MyComponent/MyComponent.py"/> 219222\end{lstlisting} 220223 • ## documentation/ossie/user-guide-0.7.0/OWDGuide.tex r8280 r8281 113113% 114114Repeat these steps to connect the ChannelDemo1'' {\it uses} port 115 {\tt samples\_out} to the RxDemo1'' {\it provides} port symbols\_in.'' 115{\tt samples\_out} to the RxDemo1'' {\it provides} port {\tt symbols\_in}. 116116Start by right-clicking on the ChannelDemo1'' component and selecting 117117Connect.'' 392392You will need to edit {\tt MyComponent.spd.xml} before your Python 393393component will work properly. Find the XML tag below the tag {\tt <code 394 type="'Executable"'>}. By default the next tag is: 395 \begin{lstlisting}[] 396 <localfile name="'bin/MyComponent"'/>} 394type="Executable">}. By default the next tag is: 395\begin{lstlisting}[] 396 <localfile name="bin/MyComponent"/>} 397397\end{lstlisting} 398398This needs to be changed to: 399399\begin{lstlisting}[] 400 <localfile name="'bin/MyComponent/MyComponent.py"'/> 400 <localfile name="bin/MyComponent/MyComponent.py"/> 401401\end{lstlisting} 402402 • ## documentation/ossie/user-guide-0.7.0/RunningWaveforms.tex r8126 r8281 1313 1414\subsection{Starting the CORBA Naming Service} 15 If you installed omniORB using {\tt rpm} and 15If you installed omniORB using {\tt rpm} or your system package manager and 1616have since restarted your machine chances are the naming service is running. 1717Refer to Appendix~\ref{appendix:services} for how to manage services under 18 Fedora Core 9. If you chose to install omniNames from tarball, you will need to 18Fedora Core 9. If you chose to install omniNames from source, you will need to 1919run {\tt omniNames.sh} (see Appendix~\ref{appendix:omninamessh}). 2020 6969Congratulations! You have just run the QPSK demonstration waveform for version 70700.7.0. From here you may be interested in learning how to create your own 71 waveforms and components using the OSSIE Waveform Developer as described 72 in the following section. 71waveforms and components using the OSSIE Eclipse Feature described 72in the following section or the OSSIE Waveform Developer described in Section~\ref{section:owd}. • ## documentation/ossie/user-guide-0.7.0/Troubleshooting.tex r8050 r8281 4343\end{lstlisting} 4444{\bf Solution: } You need to start the naming service. If you installed omniORB 45 from from RPM (see Section~\ref{section:installation:dependencies:omniorb}) 46 {\tt omniNames} will start automatically when you restart your machine. You can 45via your system's package manager, 46{\tt omniNames} will start automatically when you restart your machine, if the service is configured properly. Refer to 47Appendix~\ref{appendix:services} for instructions on managing services under Fedore Core 9. You can 4748manually start the {\tt omniNames} by creating and running the shell script 4849described in Appendix~\ref{appendix:omninamessh}. 5455exists under the Device'' spinbox. 5556 56 {\bf Solution: } This is a bug in OWD. You have probably not actually 57 selected {\tt default\_XXX\_node} even though it is visible on the screen. 57{\bf Solution: } This is a bug in OWD. You have probably not 58selected {\tt default\_XXX\_node} with the mouse, even though it is visible on the screen. 5859Click on the Node'' spinbox again and re-select {\tt default\_XXX\_node}, 5960making sure that you actually click on the text. Now when you click on the • ## documentation/ossie/user-guide-0.7.0/UserGuide.tex r8277 r8281 261261$ nameclt list
262262\end{lstlisting}
263 If the naming service is {\it not} running you will see an error something like:
263If the naming service is {\it not} running you will see an error like:
264264\begin{lstlisting}[]
265265  Unexpected error when trying to narrow the NamingContext.

315315\item ALF can start and stop waveforms.
316316\item Reduced plot tool's refresh rate.
317 \item Removed "sample waveform" option in OWD
317\item Removed sample waveform'' option in OWD.
318318\item Removed duplicate DOCTYPE descriptors in generated XML files.
319 \item Fixed path in USRP's scd file.
319\item Fixed path in USRP's SCD file.
320320\item Fixed soundCardCapture device name to prevent OWD error.
321321\item Added Ubuntu 8.04 as supported platform.
322322\item OWD default save directory is now home directory.
323323\item ALF's plot tool has normalized frequency axis.
324 \item Debug statements use DEBUG macro instead of std::cout
324\item Debug statements use DEBUG macro instead of std::cout.
325325\item Tools now installed to site-packages.
326326\item ALF, OWD, and OWD Component Editor can be run from any directory.