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

    Full output...

   C:\Users\Thomas\Desktop\openwsn-fw>scons docs
   scons: Reading SConscript files ...
    ___                 _ _ _  ___  _ _
   | . | ___  ___ ._ _ | | | |/ __>| \ |
   | | || . \/ ._>| ' || | | |\__ \|   |
   `___'|  _/\___.|_|_||__/_/ <___/|_\_|
        |_|                  openwsn.org
   scons: done reading SConscript files.
   scons: Building targets ...
   os.chdir('docs')
   doxygen Doxyfile
   os.chdir('C:\\Users\\Thomas\\Desktop\\openwsn-fw')
   scons: done building targets.

3. The documentation is created in openwsn-fw/build/docs.
4. Double-click on index.html to open the documentation:
   

openvisualizer

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

2. Enter the following command

   scons docs

    Full output...

   C:\Users\Thomas\Desktop\openwsn-sw\software\openvisualizer>scons docs
   scons: Reading SConscript files ...
    ___                 _ _ _  ___  _ _
   | . | ___  ___ ._ _ | | | |/ __>| \ |
   | | || . \/ ._>| ' || | | |\__ \|   |
   `___'|  _/\___.|_|_||__/_/ <___/|_\_|
        |_|                  openwsn.org
   HTML docs generated in build\html directory.
   scons: done reading SConscript files.
   scons: Building targets ...
   sphinx-build -b html docs build\html
   Running Sphinx v1.1.3
   loading pickled environment... failed: env version not current
   building [html]: targets for 14 source files that are out of date
   updating environment: 14 added, 0 changed, 0 removed
   reading sources... [  7%] BspEmulator
   reading sources... [ 14%] RPL
   reading sources... [ 21%] SimEngine
   reading sources... [ 28%] eventBus
   reading sources... [ 35%] index
   reading sources... [ 42%] lbrClient
   reading sources... [ 50%] moteConnector
   reading sources... [ 57%] moteProbe
   reading sources... [ 64%] moteState
   reading sources... [ 71%] openLbr
   reading sources... [ 78%] openTunWindows
   reading sources... [ 85%] openType
   reading sources... [ 92%] openVisualizerApp
   reading sources... [100%] openvisualizer_utils
   looking for now-outdated files... none found
   pickling environment... done
   checking consistency... done
   preparing documents... done
   writing output... [  7%] BspEmulator
   writing output... [ 14%] RPL
   writing output... [ 21%] SimEngine
   writing output... [ 28%] eventBus
   writing output... [ 35%] index
   writing output... [ 42%] lbrClient
   writing output... [ 50%] moteConnector
   writing output... [ 57%] moteProbe
   writing output... [ 64%] moteState
   writing output... [ 71%] openLbr
   writing output... [ 78%] openTunWindows
   writing output... [ 85%] openType
   writing output... [ 92%] openVisualizerApp
   writing output... [100%] openvisualizer_utils
   writing additional files... genindex py-modindex search
   copying static files... done
   dumping search index... done
   dumping object inventory... done
   build succeeded.
   scons: done building targets.

3. The documentation is created in openwsn-sw/software/openvisualizer/builder/html/.
4. Double-click on index.html to open the documentation: