Changeset 10598

Timestamp:

03/02/11 11:42:37 (2 years ago)

Author:

Snyder.Jason

Message:

changed version number in userguide.tex and updated wavecli output in wavecli.tex

Location:

documentation/ossie/user-guide-0.8.1

Files:

• UserGuide.tex (modified) (1 diff)
• wavecli.tex (modified) (3 diffs)

documentation/ossie/user-guide-0.8.1/UserGuide.tex

@@ -27 +27 @@
 errors per burst will be printed out on the screen while the waveform runs.}
 
-\newcommand{\ossieversion}{0.8.1}
+\newcommand{\ossieversion}{0.8.2}
 
 %@usepackage{html}

documentation/ossie/user-guide-0.8.1/wavecli.tex

@@ -13 +13 @@
 wavecli.py is a command line utility with the same capabilities as Wavedash. It can be used to install, start, query, configure, stop, and uninstall waveforms. It can also be used to list available waveforms on the system or currently running instances of waveforms. Finally, it can be used in an interactive mode that works like c\_wavloader.
 
+\subsection{Installation and Usage}
+\label{section:wavecli.py_installation_and_usage}
+wavecli.py is installed to /usr/local/lib/python2.6/dist-packages/wavedash/src by default when OSSIE is installed. It can be used from there or copied anywhere else in the filesystem. To run wavecli.py, invoke it from the command line using python like so:
+\begin{lstlisting}[]
+$ python wavecli.py <any flags>
+\end{lstlisting}
+
 \subsection{Non-interactive mode}
 \label{subsection:wavecli.py_non_interactive_mode}
 To get a listing of available waveforms, use the --listSystemWaveforms flag:
 \begin{lstlisting}[]
-$ wavecli.py --listSystemWaveforms
+$ python wavecli.py --listSystemWaveforms
 Lab5Example
 pass_data_waveform
@@ -28 +35 @@
 Once you know which waveform you wish to run, you need to install it. The --install flag takes the name of the waveform you wish to install and reports back the instance name of the running waveform if successful. 
 \begin{lstlisting}[]
-$ wavecli.py --install ossie_demo
+$ python wavecli.py --install ossie_demo
 Successfully installed ossie_demo_1
 \end{lstlisting}
 Once the waveform has been installed, it can be started using the --start flag and the name of the waveform instance.
 \begin{lstlisting}[]
-$ wavecli.py --start ossie_demo_1
+$ python wavecli.py --start ossie_demo_1
 \end{lstlisting}
 Now that the waveform is running, you can use wavecli.py to query or configure it. In this case, we will query the TxDemo component on the ossie\_demo waveform to find out how much of delay is being placed between sending packets. Then we will configure the waveform to send them faster.
 \begin{lstlisting}[]
-$ wavecli.py --query ossie_demo_1 TxDemo1
-[ossie.cf.CF.DataType(id='DCE:1b9ca208-8242-11dc-9ba3-00123f63025f',
- value=CORBA.Any(CORBA.TC_short, 500))]
+$ python wavecli.py --query ossie_demo_1 TxDemo1
+name:   packet_delay_ms
+id:     DCE:1b9ca208-8242-11dc-9ba3-00123f63025f
+type:   short
+value:  500
+
 $ wavecli.py --configure ossie_demo_1 TxDemo1 packet_delay_ms 100
 \end{lstlisting}
 Finally, the waveform should be stopped and uninstalled. These work the same way as starting a waveform: use the --stop or --uninstall flag and supply an instance name.
 \begin{lstlisting}[]
-$ wavecli.py --stop ossie_demo_1
-$ wavecli.py --uninstall ossie_demo_1
+$ python wavecli.py --stop ossie_demo_1
+$ python wavecli.py --uninstall ossie_demo_1
 \end{lstlisting}
 
@@ -52 +62 @@
 Wavecli.py also has an interactive mode that can be used to install, start, stop, and uninstall waveforms just like c\_wavLoader. To start wavecli.py in interactive mode, use the -i or --interactive flag.
 \begin{lstlisting}[]
-$ wavecli.py --interactive
+$ python wavecli.py --interactive
 Found 7 available applications