fixed doxygen warnings, problems with the images, and updated for contiki-2.x

platform/esb/doc/slipintro.txt

@@ -20,49 +20,52 @@ lets you communicate with them using standard network tools such as
 
 
 -# Click start button and choose 'My Computer'. Right-click 'My
-Network Places' and choose 'Properties'. <img src="img/esb/slip01.jpg"
+Network Places' and choose 'Properties'.
-align="center">
+<img src="img/esb/slip01.jpg" align="center">
--# Click 'Create a new connection'. <img src="img/esb/slip02.jpg" align="center">
+-# Click 'Create a new connection'.
--# Select 'Set up an advanced connection'. <img src="img/esb/slip03.jpg"
+<img src="img/esb/slip02.jpg" align="center">
-align="center">
+-# Select 'Set up an advanced connection'.
--# Select 'Connect directly to another computer'. <img
+<img src="img/esb/slip03.jpg" align="center">
-src="img/esb/slip04.jpg" align="center">
+-# Select 'Connect directly to another computer'.
--# Select 'Guest'. <img src="img/esb/slip05.jpg" align="center">
+<img src="img/esb/slip04.jpg" align="center">
--# Select a name for the slip connection (for example 'ESB'). <img
+-# Select 'Guest'.
-src="img/esb/slip06.jpg" align="center">
+<img src="img/esb/slip05.jpg" align="center">
+-# Select a name for the slip connection (for example 'ESB').
+<img src="img/esb/slip06.jpg" align="center">
 -# Select the serial port to use when communicating with the sensor
-node. <img src="img/esb/slip07.jpg" align="center">
+node.
--# Add the connection by clicking 'Finish'. <img src="img/esb/slip08.jpg"
+<img src="img/esb/slip07.jpg" align="center">
-align="center">
+-# Add the connection by clicking 'Finish'.
--# A connection window will open. Choose 'Properties'. <img
+<img src="img/esb/slip08.jpg" align="center">
-src="img/esb/slip09.jpg" align="center"> <img src="img/esb/slip10.jpg"
+-# A connection window will open. Choose 'Properties'.
-align="center">
+<img src="img/esb/slip09.jpg" align="center">
+<img src="img/esb/slip10.jpg" align="center">
 -# Click on 'Configure...' and deselect all selected
-buttons. Choose the speed 57600 bps. <img src="img/esb/slip11.jpg"
+buttons. Choose the speed 57600 bps.
-align="center">
+<img src="img/esb/slip11.jpg" align="center">
 -# Close the modem configuration window, and go to the 'Options'
 tab in the ESB properties. Deselect all except 'Display
-progress...'. <img src="img/esb/slip12.jpg" align="center">
+progress...'.
+<img src="img/esb/slip12.jpg" align="center">
 -# Go to the 'Networking' tab. Change to 'SLIP: Unix Connection'
 and deselect all except the first two items in the connection item
-list. <img src="img/esb/slip13.jpg" align="center">
+list.
+<img src="img/esb/slip13.jpg" align="center">
 -# Select 'Internet Protocol (TCP/IP)' and click
-'Properties'. Enter the IP address '172.16.0.1'. <img
+'Properties'. Enter the IP address '172.16.0.1'.
-src="img/esb/slip14b.jpg" align="center">
+<img src="img/esb/slip14b.jpg" align="center">
 -# Click 'Advanced' and deselect all checkboxes in the 'Advanced
 TCP/IP Settings'. Go to the 'WINS' tab and deselect 'Enable LMHOSTS
 lookup' if it is selected. Also select 'Disable NetBIOS over
-TCP/IP'. <img src="img/esb/slip15.jpg" align="center"> <img
+TCP/IP'.
-src="img/esb/slip16.jpg" align="center">
+<img src="img/esb/slip15.jpg" align="center">
-
+<img src="img/esb/slip16.jpg" align="center">
-
 
 
 \section slipintro-setup Setup ESB for over the air programming
 
--# Make sure you have the latest contiki, contiki-msp430, and
+-# Make sure you have the latest version of contiki (older versions of
-contiki-esb (older versions of contiki might not work with SLIP under
+   contiki might not work with SLIP under Windows)
-Windows)
 -# Install the contiki kernel by running
 \code
 make core.u
@@ -93,8 +96,8 @@ node id, the node will have the IP address 172.16.1.2. Each node
 should have its own unique node id.
 
 You need to compile a core and upload it onto the nodes. All nodes
-must run the same core. Move to the directory '\c contiki-esb' and
+must run the same core. Move to the directory
-run
+'<tt>contiki-2.x/platform/esb</tt>' and run
 
 \code
 make

platform/esb/doc/winintro.txt

@@ -26,8 +26,8 @@ be found at http://www.cygwin.com. Click on the icon "Install
 Cygwin Now" to the right to get the installation started.
 
 Choose "Install from Internet" and then specify where you want to
-install cygwin (recommended installation path: \c
+install cygwin (recommended installation path:
-C:$\backslash$cygwin). Continue with the installation until you are
+<tt>C:\\cygwin</tt>). Continue with the installation until you are
 asked to select packages. Most packages can be left as "Default" but
 there is one package that are not installed by default. Install the
 following package by clicking at "Default" until it changes to
@@ -54,23 +54,15 @@ http://www.crimsoneditor.com/
 The editor is useful both when editing C programs and when
 modifying scripts and configuration files.
 
-\subsection winintro-installing-compiler MSP430 Compiler and tools}
+\subsection winintro-installing-compiler MSP430 Compiler and tools
 
-The MSP430 compiler (a version of gcc) is needed to compile the
+A compiler is needed to compile the programs to the MSP430
-programs to the MSP430 microprocessor that is used on the ESB
+microprocessor that is used on the ESB sensor nodes. Download and
-sensor nodes. We have made a webpage which describe how to get the compilers
+install the GCC toolchain for MSP430 (recommended installation path:
-and other tools for programming the ESB nodes, see:
+C:\\MSP430\\).
-http://www.sics.se/sensornets/esblab/
 
-Download and install the GCC toolchain for MSP430
+The GCC toolchain for MSP430 can be found at:
-(recommended installation path: C:$\backslash$MSP430$\backslash$):
+http://sourceforge.net/projects/mspgcc/
-\c mspgcc-20041112.exe.
-
-You will also need some tools for sending the compiled programs
-over to the ESB nodes. Install the
-IAR Embedded Workbench (Kickstart Version) package
-(recommended installation path: C:$\backslash$MSP430$\backslash$IARSystems):
-\c fet_r304.exe.
 
 When the above software is installed you also need to set-up the
 PATH so that all of the necessary tools can be reached. In cygwin
@@ -78,19 +70,17 @@ this is done by the following line (given that you have installed
 at recommended locations):
 
 <tt>
-export PATH=\$PATH:/cygdrive/c/MSP430/IARSystems/ew23:\newline
+export PATH=\$PATH:/cygdrive/c/MSP430/mspgcc/bin
-/cygdrive/c/MSP430/IARSystems/ew23/430/bin:/cygdrive/c/MSP430/mspgcc/bin
 </tt>
 
 This line can also be added to the .profile startup file in your cygwin
-home directory \newline
+home directory
-(<tt>C:$\backslash$cygwin$\backslash$home$\backslash$<YOUR
+(<tt>C:\\cygwin\\home\\\<YOUR USERNAME\>\\.profile</tt>).
-USERNAME>$\backslash$.profile\end</tt>).
 
 If your home directory is located elsewhere you can find it by
 starting cygwin and running \c cd followed by \c pwd.
 
-\subsection winintro-installing-contiki The Contiki operating system, including examples and labs
+\subsection winintro-installing-contiki The Contiki operating system, including examples
 
 When programming the ESB sensor nodes it is very useful to have an
 operating system that takes care of some of the low-level tasks and
@@ -99,66 +89,47 @@ and networking.  We will use the Contiki operating system developed by
 Adam Dunkels, SICS, which is very well suited when programming small
 embedded systems.
 
-Download Contiki for ESB nodes from the same page as before (Contiki
+The Contiki OS can be found at:
-ESB).
+http://www.sics.se/~adam/contiki/
 
-Unzip the Contiki OS at (for example) C:$\backslash$
+Unzip the Contiki OS at (for example) C:\\
-and you will get the following directories:
+and you will get the following directories among others:
 
-- esblab/contiki - the contiki operating system
+- contiki-2.x/core - the contiki operating system
-- esblab/contiki-esb - the contiki operating system drivers, etc for the ESB
+- contiki-2.x/platform/esb - the contiki operating system drivers, etc for the ESB
-- esblab/contiki-esb/labs - the example and lab files
+- contiki-2.x/platform/esb/apps/ - example applications for the ESB
 
 \section winintro-testing Testing the tools
 
 Now everything necessary to start developing Contiki-based sensor net
 applications should be installed. Start cygwin and change to the
-directory \c labs/intro. Then call <tt> make esbintro</tt>.
+directory <tt>contiki-2.x/platform/esb/</tt>. Then call <tt>make
+beeper.co</tt>.
 
 If you get an error about multiple cygwin dlls when compiling, you
-need to delete \c cygwin1.dll from the MSP430 GCC toolchain (\c
+need to delete <tt>cygwin1.dll</tt> from the MSP430 GCC toolchain
-C:$\backslash$MSP430$\backslash$bin$\backslash$cygwin1.dll).
+(<tt>C:\\MSP430\\bin\\cygwin1.dll</tt>).
 
 Connect a node and turn it on. Upload the test application by calling
-\c make esbintro.u.
+<tt>make beeper.u</tt>.
 
 \subsection winintro-testing-development Development tools
 
-- <tt>make <SPEC></tt> will compile and make a executable file ready for
+- <tt>make \<SPEC\></tt> will compile and make a executable file ready
-sending to the ESB nodes. Depending on the SPEC it might even startup
+for sending to the ESB nodes. Depending on the \c SPEC it might even
-the application that sends the executable to the node. During this
+startup the application that sends the executable to the
-course you would typically write things like <tt>"make
+node. Typically you would write things like <tt>"make beeper.u"</tt>
-  esbintro.u"</tt> to get the file esbintro.c compiled, linked and
+to get the file <tt>beeper.c</tt> compiled, linked and sent out to the
-sent out to the ESB node
+ESB node
-
-- cw23 starts up the CSPY program that sends programs to the
-ESB nodes and allow debugging (usually started by the \c make
-
 
 \subsection winintro-testing-shell Some basic shell commands
 
-- <tt> cd <DIR></tt> change to a specified directory (same as in DOS)
+- <tt> cd \<DIR\></tt> change to a specified directory (same as in DOS)
-- <tt> pwd <DIR></tt> shows your current directory
+- <tt> pwd \<DIR\></tt> shows your current directory
 - <tt> ls</tt> list the directory
-- <tt> mkdir <DIR></tt> creates a new directory
+- <tt> mkdir \<DIR\></tt> creates a new directory
-- <tt> cp <SRC> <DEST></tt> copies a file
+- <tt> cp \<SRC\> \<DEST\></tt> copies a file
-
-\subsection winintro-testing-excercises
-
- * compile and start the \c esbintro application (remember to change
-   directory to contiki-esb before you run \c make)
- * modify the C code and make the yellow led be on when the red is
- off (and vice versa). The code is in the \c contiki-esb/labs/intro
-folder. Hint: Add another line controlling the yellow led in the section:
-\code
-  if (timer_expired(&timer)) {
-    timer_reset(&timer);
-    leds_red(on ? LEDS_ON : LEDS_OFF);
-    on = !on;
-  }
-\endcode
 
 */
 /** @} */
 /** @} */
-