Frank Vannieuwkerke / Mbed 2 deprecated Wi-Go_IOT_Demo

Port from Avnet's Internet Of Things full WiGo demo: SmartConfig - WebServer - Exosite - Android sensor Fusion App

Dependencies:   mbed CC3000_Hostdriver TEMT6200 TSI Wi-Go_eCompass_Lib_V3 WiGo_BattCharger

Fork of CC3000_Simple_Socket by Frank Vannieuwkerke

Wi-Go Reference Design Overview

For additional information on Wi-Go, please visit http://www.em.avnet.com/wi-go
For additional information on Freescale eCompass, please visit
http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=E-Compass
Ported from Avnet's Wi-Go KEIL code.
Special thanks to Jim Carver from Avnet for providing the Wi-Go board and for his assistance.

Multiple Wi-Fi applications are provided within the latest version of Wi-Go software:

• SmartConfig App for auto-setup of Wi-Go network parameters.
• WebServer display of live sensor data.
• Exosite portal sensor data feed by Wi-Go.
• Freescale's Sensor Fusion App data feed by Wi-Go.

Wi-Go is intended for "untethered" portable operation (using it's high-capacity Lithium-Polymer battery). The serial terminal text interface is only required for initial setup, thereafter selection of an application from those available is via finger position on the Touch Slider during the initial 6 second startup period.

Running the Wi-Go Demo Suite

Startup
The RGB LED blinks in a GREEN-ORANGE sequence to inform the user the module is waiting for input.
The RGB LED color designates which of the following Apps to launch.

Swipe your index finger across the slider pad, the RGB LED color will change at approximately 25% intervals.
Removing your finger latches the last color displayed. After about 3 seconds, the selected app will start.
Another app can be selected when the slider pad is touched again within the 3 seconds timeout.

After launch of Exosite or Android Server Apps, the eCompass function then controls the RGB LED.
(not in WebServer mode where RGB LEDs are manually controlled by the User).

__Note!__ The D1, D2 and D3 User LEDs on Wi-Go adhere to the following convention for the different Apps

Detail of Wi-Go Applications

App #1: SmartConfig
See TI's pages on how to use the SmartConfig tool:

• Preferred method : Configuration using the SmartConfig tool
  
• SmartConfig download: Smart Config and Home Automation
  
  • iOS app : available at Apple app store.
    
  • Android app : download and install the Android SmartConfig Application on a PC.
    This file contains the source code as well as the compiled APK file.
    The APK file is stored in ti\CC3000AndroidApp\SmartConfigCC3X\bin.

App #2: WebServer display of live sensor data
__Note!__
When using the WebServer for the first time on a Wi-Fi network you will need to determine the IP address that's assigned to Wi-Go by the DHCP Server. To do this, it is recommended you use one of the following two methods:

• While Wi-Go is initially tethered to a laptop via USB, launch of the WebServer Application and note the IP address that is reported on the terminal screen immediately after selection of this App.
• Alternatively, use a 3^rd party LAN SCAN type tool to view Wi-Go's IP address.
  eg. FING, - available for free download from Google Play or iTunes App Stores…

Wi-Go's WebServer Application is selected as follows:

• Press RESET, followed by the eCompass Calibration (mentioned at the top of this page).
  Then use index finger on slider to select the WebServer App (RGB LED = BLUE).
  At end of the 3 second selection period the WebServer App shall launch.
  
• If you are tethered to a laptop and have a terminal open the Wi-Fi network connection confirmation will be seen, eg.

'*** Wi-Go board DHCP assigned IP Address = 192.168.43.102

• Once you have noted Wi-Go's reported IP address, the USB cable may be disconnected and Wi-Go then used as intended, running on it's own battery power.
  
• Use an Internet Browser on SmartPhone/Tablet/Laptop (connected to same Hot-Spot/Wireless Router subnet), to now connect to the noted Wi-Go IP address and view the WebServer output:
• the Webserver sensor data is auto-updated every 2 seconds a manual refresh (F5 on laptop).
• In the event of an error, press refresh to regenerate the screen.
• Use the mouse (or touch-screen) to exercise the RGB LED output.

App #3: Exosite Data Client
Wi-Go's sensor data gets transmitted via Wi-Fi to a cloud-based Exosite portal where the sensor measurements are displayed graphically on a "dashboard". Users can create unique customized dashboards using drag and drop GUI widgets from the library provided on the Exosite website.
__Note!__ For the Exosite application a "live" connection to the Internet is required !!!

• Press RESET, followed by the eCompass Calibration (mentioned at the top of this page).
  Then use index finger on slider to select the Exosite Client App (RGB LED = RED)
• On launching this App, note Wi-Go's MAC address displayed on your terminal
  (if not running a terminal use FING or other WLAN Scan tool to determine Wi-Go's MAC address)
• Using your computer's internet browser, go to avnet.exosite.com and sign-up for a free Avnet Trial Exosite Account:
• On the next screen, click on the Sign-Up Now button in the displayed Avnet Trial account option.
• Complete the Account Info and Contact Info then click on Create Account (make sure to use a valid email address!).
• Check for new incoming email from avnet.exosite.com to the address you provided and click on the link in this email to activate your new Exosite account.
• Once activated, login using the email address and password that you chose in your registration. Your Exosite Portal and Dashboard should now display. The first time you log-in to your new account, the default Home dashboard will be displayed, pre-configured with two widgets. On the left is the Welcome widget for tips and information. On the right is the Device List widget.
  Dashboards are configurable, so at any time this default dashboard can be changed, widgets deleted and added (Clicking the upside-down triangle icon in a widget's Title bar will allow you to edit it).
• Before going further with the Dashboard, you need to connect your Wi-Go device to your Exosite account. Do this by going to the left sidebar and selecting Devices followed by selecting the +Add Device link (on right of screen).
• In the Setup screens that follow, enter the following

• Once completed, under Devices the name chosen for the added Wi-Go device should now be listed.
• Click on this new Wi-Go device to examine (and edit if necessary) it's Device Information screen.
  
• Click the CLOSE button to exit the Device Information screen.
• On your Wi-Go kit now press RESET, followed by the eCompass Calibration (mentioned at the top of this page)
  and again select the Exosite Client App (RGB LED = RED) using your index finger.
• Refresh your browser (press F5) a couple've times until the Active indicator changes to On (Green).
  
• From the left sidebar click on Home and click on the recently named Wi-Go device which is located under the Device List.
  This will bring-up a default dashboard display similar to what's shown below.
  (Dashboards are typically accessed via the Dashboards menu entry). Check the dashboard is updating with live data by moving your Wi-Go Kit through different orientations.
  
• To create a custom dashboard, select Dashboards from the sidebar menu, followed by +Add Dashboard (on right side of Your Dashboards title bar). After completion of the initial configuration screen you will then be able to add Widgets to display the various Wi-Go data sources as well as pictures and text to support your application.
  
• More guidance on the creation, editing and sharing of custom dashboards is available under the Exosite support pages
  

App #4: Android Sensor Fusion App

• Press RESET, followed by the eCompass Calibration (mentioned at the top of this page)
  , then use index finger on slider to select the Android App (RGB LED = GREEN)
  
• Freescale's ''Xtrinsic Sensor Fusion Toolbox'" will run on Android 3.0 or above phone or tablet. Free to download from Google Play, type Sensor fusion in the search box to find it. freescale.sensors.sfusion
• The Freescale App is well documented. To access the built-in documentation, press the NAV button at top of screen followed by Documentation from the scroll-down menu:
  
• Freescale's sensors site provides additional resources such as this overview: free-android-app-teaches-sensor-fusion-basics
  
• Go to the Options Menu and select Preferences…
• The following items need to be taken care of:

• Press Save and Exit!
  
• Exit the Application completely then re-launch the Sensor Fusion Application.
• Select the ''Source/Algorithm'" menu and change the data source to Wi-Go mag/accel
• The Android App should now be displaying a 3-D image of Wi-Go that you can rotate and flip-over by moving the Wi-Go board accordingly…
• Use NAV > Device View to display if this view does not come-up by default.
• A Serial Terminal connection is not necessary but if you happen to have one open you should see the following messages as Wi-Go connects to the Android App:
  "Server waiting for connection" followed by
  "connected, transmit buffer size= 96", and then
  "input = 0123456789"
  at which time Wi-Go starts streaming data to the Android App.

/*****************************************************************************
*
*  cc3000.h - CC3000 Function Definitions
*  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions
*  are met:
*
*    Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
*
*    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.
*
*    Neither the name of Texas Instruments Incorporated 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 
*  OWNER 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.
*
*****************************************************************************/

#ifndef CC3000_H
#define CC3000_H

#include "wlan.h"

//*****************************************************************************
//
//! \addtogroup cc3000
//! @{
//
//*****************************************************************************

/** CC3000 Functions
*
*/
#ifdef    __cplusplus
extern "C" {
#endif

extern DigitalOut ledr;
extern DigitalOut ledg;
extern DigitalOut ledb;
extern DigitalOut led1;
extern DigitalOut led2;
extern DigitalOut led3;

#define RED_OFF        ledr = 1;
#define RED_ON         ledr = 0;
#define RED_TOGGLE     ledr = !ledr;
#define GREEN_OFF      ledg = 1;
#define GREEN_ON       ledg = 0;
#define GREEN_TOGGLE   ledg = !ledg;
#define BLUE_OFF       ledb = 1;
#define BLUE_ON        ledb = 0;
#define BLUE_TOGGLE    ledb = !ledb;
#define LED_D1_OFF     led1 = 1;
#define LED_D1_ON      led1 = 0;
#define LED_D1_TOGGLE  led1 = !led1;
#define LED_D2_OFF     led2 = 1;
#define LED_D2_ON      led2 = 0;
#define LED_D2_TOGGLE  led2 = !led2;
#define LED_D3_OFF     led3 = 1;
#define LED_D3_ON      led3 = 0;
#define LED_D3_TOGGLE  led3 = !led3;

#define SOCKET_INACTIVE_ERR             -57
#define NUM_STATES                      6
#define MAX_SSID_LEN                    32
#define FIRST_TIME_CONFIG_SET           0xAA
#define NETAPP_IPCONFIG_MAC_OFFSET      (20)
#define CC3000_APP_BUFFER_SIZE          (5)
#define CC3000_RX_BUFFER_OVERHEAD_SIZE  (20)

// CC3000 State Machine Definitions
enum cc3000StateEnum
{
    CC3000_UNINIT           = 0x01, // CC3000 Driver Uninitialized
    CC3000_INIT             = 0x02, // CC3000 Driver Initialized
    CC3000_ASSOC            = 0x04, // CC3000 Associated to AP
    CC3000_IP_ALLOC         = 0x08, // CC3000 has IP Address
    CC3000_SERVER_INIT      = 0x10, // CC3000 Server Initialized
    CC3000_CLIENT_CONNECTED = 0x20  // CC3000 Client Connected to Server
};


/**
* Turn all LEDs Off
* @param  none
* @return none
*/
void initLEDs(void);

/** Connect to an Access Point using the specified SSID.
* @param  ssidName is a string of the AP's SSID
* @return none
*/
int ConnectUsingSSID(char * ssidName);

/** Handle asynchronous events from CC3000 device.
* @param  lEventType  Event type
* @param  data
* @param  length
* @return none
*/
void CC3000_UsynchCallback(long lEventType, char * data, unsigned char length);

/** Initialize a CC3000 device and triggers it to start operation.
* @param  none
* @return none
*/
int initDriver(void);

/** Return the highest state which we're in.
* @param  None
* @return none
*/
char highestCC3000State(void);

/** Return the current state bits.
* @param  None
* @return none
*/
char currentCC3000State(void);

/** Sets a state from the state machine.
* @param  None
* @return none
*/
void setCC3000MachineState(char stat);

/** Unsets a state from the state machine.
* Also handles LEDs.\n
* @param  None
* @return none
*/
void unsetCC3000MachineState(char stat);

/** Resets the State Machine.
* @param  None
* @return none
*/
void resetCC3000StateMachine(void);

/** Obtains the CC3000 Connection Information from the CC3000.
* @param  None
* @return none
*/
#ifndef CC3000_TINY_DRIVER
tNetappIpconfigRetArgs * getCC3000Info(void);
#endif

/** Trigger a smart configuration process on CC3000.
* It exits upon completion of the process.\n
* @param  None
* @return none
*/
void StartSmartConfig(void);

#ifdef    __cplusplus
}
#endif // __cplusplus

//*****************************************************************************
//
// Close the Doxygen group.
//! @}
//
//*****************************************************************************

#endif // CC3000_H