The software and firmware source code contains in-line documentation:

• The OpenVisualizer is documented using Sphinx.

• The Firmware is documented using doxygen.

Consult documentation

The documentation is built nightly and published at http://openwsn-berkeley.github.io/.

Publication is done using the following jobs on the OpenWSN builder:

Build documentation

You can build the documentation locally on your computer, using an SCons target.

firmware

1. Using the command line, navitage to openwsn-fw/.

2. Enter the following command

   scons docs

3. The documentation is created in openwsn-fw/build/docs.

4. Double-click on index.html to open the documentation:

   Open

   

openvisualizer

1. Using the command line, navitage to openwsn-sw/software/openvisualizer/.

2. Enter the following command

   scons docs

3. The documentation is created in openwsn-sw/software/openvisualizer/builder/html/.

4. Double-click on index.html to open the documentation:

   Open