.. NRC Tools documentation master file, created by
   sphinx-quickstart on Wed Sep 22 10:24:32 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

SWiSS User Guide
================

**Author**: *Dareun Geum*

**Version**: *v1.0*

SWiSS (Spatial WiFi Site Survey) toolkit is a collection of tools designed to facilitate indoor and outdoor WiFi HaLow coverage testing and analysis. This tutorial will cover the basic usage of the toolkit and illustrate a typical workflow.

    .. image:: images/swiss.png

The SWiSS toolkit consists of five components:

    1. **STAT**: Spatial Test Automation Tool
        - **(STA-side)** Automated measurement logging tool

    2. **WAVE**: WiFi Area Visual Evaluator
        - Heatmap generation tool

    3. **Instructions**
        - Web-based documentation on SWiSS usage

    4. **SPOT**: Spatial Position Organizing Tool
        - Spatial coordinate marking tool

    5. **SCAN**: Station Control & Activity Nexus
        - **(AP-side)** STA activity monitoring tool

Requirements
------------
    * The tool requires **Java Runtime Environment (JRE8)**. Download and install the OS-compatible version of JRE8 for the PC.

    * The SWiSS AP/STA servers need to be running on the EVK. For enabling SWiSS on older EVKs, refer to the **NRC7394 EVK User Guide** web documentation for more information.

.. toctree::
    :maxdepth: 2
    :caption: Main Tool Usage:
 
    stat
    stat_data_collection_outdoor
    stat_data_collection_indoor
    wave

.. toctree::
    :maxdepth: 2
    :caption: Supplementary Tool Usage:
 
    spot
    scan

