1. Introduction

The current documentation is based on GIT version 533c3d8 of WiSense code. The code can be obtained from BitBucket.

To understand what WiSense is all about, read section System Overview. This gives a high-level view of the system and the kind of applications it enables. If you are new to Wireless Sensor Networks (WSN) and Internet of Things (IoT), this is a good place to start.

Section Installation details simple steps to install the complete development environment including MSP430 toolchain. You can setup the development environment in either Windows or Linux. Once your development environment is ready, the section will also guide you in writing, compiling and running your first application.

Section Getting Started will lead you through a sample application. In the process, you will get to learn the modules and their interfaces. This is probably the best way to learn how to program on the WiSense platform.

Those who wish to develop RFD applications should read section RFD App to familiarize themselves with the application framework. Section App Examples has many examples that will be useful to application developers.

Those who wish to integrate new sensors to the WiSense platform should read section Sensors. The section also contains useful information on sensors already integrated to the platform. To integrate sensors, you will need to look up the hardware schematics and the pinouts. These are documented in section Hardware API.

On WiSense software, only functions and global variables are documented. Illustrative code examples are also included. Macros and type definitions are not documented for the moment.

Some modules are not documented: MAC layer, platform code related to CC2520, Node Manager (NM), Device Interface Specification (DIS), application layer for non-RFD devices, multihop mesh routing, UDP and IPv4. Direct calls to these modules are extremely rare or optional for application developers. Hence they have been left out. They may be documented in future.

If you find something wrong with the documentation, let us know. Happy coding!

1.1. Licensing

WiSense is an open platform. The conditions of licensing source code is detailed below, which must be included in redistributed code and documentation:

/*
* Copyright (c) <2014>, <ram krishnan>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
*  1. Redistributions of source code must retain the above copyright notice, this
*     list of conditions and the following disclaimer.
*  2. Redistributions in binary form must reproduce the above copyright notice,
*     this list of conditions and the following disclaimer in the documentation
*     and/or other materials provided with the distribution.
*  3. Neither the name of the copyright holder nor the names of its contributors
*     may be used to endorse or promote products derived from this software without
*     specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*/