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

Information

This demo uses the old HostDriver.
A newer release using the mbed socket compatible API HostDriver is available at Wi-Go_IOT_Demo_MKII.

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

Warning

  • We need a large amount of free RAM for the eCompass library:
    Before compiling the code, check if CC3000_MAXIMAL_RX_SIZE is set to (511 + 1) in cc3000_common.h.
  • The on-board Firmware must be updated to mbed enable a Wi-Go system. Goto the Component page to get the FirmwareUpdate tool (scroll down to the FirmwareUpdate topic).

MAG3110 sensor and eCompass Calibration!

As with the other sensor applications, the eCompass function requires quality calibration data to achieve best accuracy.
For the first 15 seconds after power-up it is recommended that "Figure 8" movements with Wi-Go be done in a smooth, repetitive pattern. Don't touch the slider pad during calibration.

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.

RGB LED ColorApplication to Launch
PurpleSmartConfig
BlueWebServer
RedExosite Data Client
GreenAndroid Server

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).

RGB LED ColorDirection Indication
BlueNear to North
GreenNorth
RedEast / West
PurpleSouth

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

User LED#Description of function controlling the LED
D1is the board heartbeat, derived from the timer interrupt
D2indicates network activity as follows:
Web Server Wi-Go webpage is being served.
Exosite Client Wi-Go is sending data.
Android App Wi-Go is sending data
D3WLAN Network is Connected

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 3rd 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: /media/uploads/frankvnk/wi-go_webserver.png
  • 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) /media/uploads/frankvnk/mac_address.png
  • Using your computer's internet browser, go to avnet.exosite.com and sign-up for a free Avnet Trial Exosite Account: /media/uploads/frankvnk/avnet_trial_exosite.png
  • 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). /media/uploads/frankvnk/add_device.png
  • In the Setup screens that follow, enter the following
Select a supported deviceWi-Go
Enter device MAC Addressnn:nn:nn:nn:nn:nn [your Wi-Go's MAC address including colons]
Enter device Name[choose a descriptive name]
Enter device Location[description of your location]
  • 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.
    /media/uploads/frankvnk/device_information.png
  • 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).
    /media/uploads/frankvnk/active_indicator.png
  • 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.
    /media/uploads/frankvnk/dashboard.png
  • 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 /media/uploads/frankvnk/sensor_fusion_toolbox.png
  • 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:
    /media/uploads/frankvnk/sensor_fusion_doc.png
  • 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… /media/uploads/frankvnk/sensor_fusion_preferences.png
  • The following items need to be taken care of:
Enter WiGo's IP address
Enter the SSID (of the Hot-Spot or Wireless Access Point used by Wi-Go)
  • Press Save and Exit!
    /media/uploads/frankvnk/sensor_fusion_save_and_exit.png
  • 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 /media/uploads/frankvnk/sensor_fusion_wigo_mag_accel.png
  • 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. /media/uploads/frankvnk/sensor_fusion_nav_device_view.png
  • 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.
Committer:
frankvnk
Date:
Wed Dec 11 20:31:02 2013 +0000
Revision:
16:dceb9f5108f7
Parent:
3:405462258899
faster i2c (375KHz)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 3:405462258899 1 /*****************************************************************************
frankvnk 3:405462258899 2 *
frankvnk 3:405462258899 3 * exosite_meta.c - Exosite meta information handler.
frankvnk 3:405462258899 4 * Copyright (C) 2012 Exosite LLC
frankvnk 3:405462258899 5 *
frankvnk 3:405462258899 6 * Redistribution and use in source and binary forms, with or without
frankvnk 3:405462258899 7 * modification, are permitted provided that the following conditions
frankvnk 3:405462258899 8 * are met:
frankvnk 3:405462258899 9 *
frankvnk 3:405462258899 10 * Redistributions of source code must retain the above copyright
frankvnk 3:405462258899 11 * notice, this list of conditions and the following disclaimer.
frankvnk 3:405462258899 12 *
frankvnk 3:405462258899 13 * Redistributions in binary form must reproduce the above copyright
frankvnk 3:405462258899 14 * notice, this list of conditions and the following disclaimer in the
frankvnk 3:405462258899 15 * documentation and/or other materials provided with the
frankvnk 3:405462258899 16 * distribution.
frankvnk 3:405462258899 17 *
frankvnk 3:405462258899 18 * Neither the name of Texas Instruments Incorporated nor the names of
frankvnk 3:405462258899 19 * its contributors may be used to endorse or promote products derived
frankvnk 3:405462258899 20 * from this software without specific prior written permission.
frankvnk 3:405462258899 21 *
frankvnk 3:405462258899 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
frankvnk 3:405462258899 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
frankvnk 3:405462258899 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
frankvnk 3:405462258899 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
frankvnk 3:405462258899 26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
frankvnk 3:405462258899 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
frankvnk 3:405462258899 28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
frankvnk 3:405462258899 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
frankvnk 3:405462258899 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
frankvnk 3:405462258899 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
frankvnk 3:405462258899 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
frankvnk 3:405462258899 33 *
frankvnk 3:405462258899 34 *****************************************************************************/
frankvnk 3:405462258899 35 #include "exosite_meta.h"
frankvnk 3:405462258899 36 #include "exosite_hal.h"
frankvnk 3:405462258899 37 #include "mbed.h"
frankvnk 3:405462258899 38 //#include "strlib.h"
frankvnk 3:405462258899 39 //#include "stdlib.h"
frankvnk 3:405462258899 40
frankvnk 3:405462258899 41 // local defines
frankvnk 3:405462258899 42
frankvnk 3:405462258899 43 // local functions
frankvnk 3:405462258899 44
frankvnk 3:405462258899 45 // externs
frankvnk 3:405462258899 46
frankvnk 3:405462258899 47 // global variables
frankvnk 3:405462258899 48
frankvnk 3:405462258899 49
frankvnk 3:405462258899 50 //*****************************************************************************
frankvnk 3:405462258899 51 //
frankvnk 3:405462258899 52 //! exosite_meta_init
frankvnk 3:405462258899 53 //!
frankvnk 3:405462258899 54 //! \param None
frankvnk 3:405462258899 55 //!
frankvnk 3:405462258899 56 //! \return None
frankvnk 3:405462258899 57 //!
frankvnk 3:405462258899 58 //! \brief Does whatever we need to do to initialize the NV meta structure
frankvnk 3:405462258899 59 //
frankvnk 3:405462258899 60 //*****************************************************************************
frankvnk 3:405462258899 61 void exosite_meta_init(void)
frankvnk 3:405462258899 62 {
frankvnk 3:405462258899 63 char strBuf[META_MARK_SIZE];
frankvnk 3:405462258899 64
frankvnk 3:405462258899 65 exoHAL_EnableMeta(); //turn on the necessary hardware / peripherals
frankvnk 3:405462258899 66
frankvnk 3:405462258899 67 //check our meta mark - if it isn't there, we wipe the meta structure
frankvnk 3:405462258899 68 exosite_meta_read((unsigned char *)strBuf, META_MARK_SIZE, META_MARK);
frankvnk 3:405462258899 69 if (strncmp(strBuf, EXOMARK, META_MARK_SIZE)) exosite_meta_defaults();
frankvnk 3:405462258899 70
frankvnk 3:405462258899 71 }
frankvnk 3:405462258899 72
frankvnk 3:405462258899 73
frankvnk 3:405462258899 74 //*****************************************************************************
frankvnk 3:405462258899 75 //
frankvnk 3:405462258899 76 //! exosite_meta_defaults
frankvnk 3:405462258899 77 //!
frankvnk 3:405462258899 78 //! \param None
frankvnk 3:405462258899 79 //!
frankvnk 3:405462258899 80 //! \return None
frankvnk 3:405462258899 81 //!
frankvnk 3:405462258899 82 //! \brief Writes default meta values to NV memory. Erases existing meta
frankvnk 3:405462258899 83 //! information!
frankvnk 3:405462258899 84 //
frankvnk 3:405462258899 85 //*****************************************************************************
frankvnk 3:405462258899 86 void exosite_meta_defaults(void)
frankvnk 3:405462258899 87 {
frankvnk 3:405462258899 88 const unsigned char meta_server_ip[6] = {173,255,209,28,0,80};
frankvnk 3:405462258899 89
frankvnk 3:405462258899 90 exoHAL_EraseMeta(); //erase the information currently in meta
frankvnk 3:405462258899 91 exosite_meta_write((unsigned char *)meta_server_ip, 6, META_SERVER); //store server IP
frankvnk 3:405462258899 92 exosite_meta_write((unsigned char *)EXOMARK, META_MARK_SIZE, META_MARK); //store exosite mark
frankvnk 3:405462258899 93
frankvnk 3:405462258899 94 return;
frankvnk 3:405462258899 95 }
frankvnk 3:405462258899 96
frankvnk 3:405462258899 97
frankvnk 3:405462258899 98 //*****************************************************************************
frankvnk 3:405462258899 99 //
frankvnk 3:405462258899 100 //! exosite_meta_write
frankvnk 3:405462258899 101 //!
frankvnk 3:405462258899 102 //! \param write_buffer - string buffer containing info to write to meta;
frankvnk 3:405462258899 103 //! srcBytes - size of string in bytes; element - item from
frankvnk 3:405462258899 104 //! MetaElements enum.
frankvnk 3:405462258899 105 //!
frankvnk 3:405462258899 106 //! \return None
frankvnk 3:405462258899 107 //!
frankvnk 3:405462258899 108 //! \brief Writes specific meta information to meta memory.
frankvnk 3:405462258899 109 //
frankvnk 3:405462258899 110 //*****************************************************************************
frankvnk 3:405462258899 111 void exosite_meta_write(unsigned char * write_buffer, unsigned short srcBytes, unsigned char element)
frankvnk 3:405462258899 112 {
frankvnk 3:405462258899 113 exosite_meta * meta_info = 0;
frankvnk 3:405462258899 114
frankvnk 3:405462258899 115 //TODO - do not write if the data already there is identical...
frankvnk 3:405462258899 116
frankvnk 3:405462258899 117 switch (element)
frankvnk 3:405462258899 118 {
frankvnk 3:405462258899 119 case META_CIK:
frankvnk 3:405462258899 120 if (srcBytes > META_CIK_SIZE) return;
frankvnk 3:405462258899 121 exoHAL_WriteMetaItem(write_buffer, srcBytes, (int)meta_info->cik); //store CIK
frankvnk 3:405462258899 122 break;
frankvnk 3:405462258899 123 case META_SERVER:
frankvnk 3:405462258899 124 if (srcBytes > META_SERVER_SIZE) return;
frankvnk 3:405462258899 125 exoHAL_WriteMetaItem(write_buffer, srcBytes, (int)meta_info->server); //store server IP
frankvnk 3:405462258899 126 break;
frankvnk 3:405462258899 127 case META_MARK:
frankvnk 3:405462258899 128 if (srcBytes > META_MARK_SIZE) return;
frankvnk 3:405462258899 129 exoHAL_WriteMetaItem(write_buffer, srcBytes, (int)meta_info->mark); //store exosite mark
frankvnk 3:405462258899 130 break;
frankvnk 3:405462258899 131 case META_UUID:
frankvnk 3:405462258899 132 if (srcBytes > META_UUID_SIZE) return;
frankvnk 3:405462258899 133 exoHAL_WriteMetaItem(write_buffer, srcBytes, (int)meta_info->uuid); //store UUID
frankvnk 3:405462258899 134 break;
frankvnk 3:405462258899 135 case META_MFR:
frankvnk 3:405462258899 136 if (srcBytes > META_MFR_SIZE) return;
frankvnk 3:405462258899 137 exoHAL_WriteMetaItem(write_buffer, srcBytes, (int)meta_info->mfr); //store manufacturing info
frankvnk 3:405462258899 138 break;
frankvnk 3:405462258899 139 case META_NONE:
frankvnk 3:405462258899 140 default:
frankvnk 3:405462258899 141 break;
frankvnk 3:405462258899 142 }
frankvnk 3:405462258899 143 return;
frankvnk 3:405462258899 144 }
frankvnk 3:405462258899 145
frankvnk 3:405462258899 146
frankvnk 3:405462258899 147 //*****************************************************************************
frankvnk 3:405462258899 148 //
frankvnk 3:405462258899 149 //! exosite_meta_read
frankvnk 3:405462258899 150 //!
frankvnk 3:405462258899 151 //! \param read_buffer - string buffer to receive element data; destBytes -
frankvnk 3:405462258899 152 //! size of buffer in bytes; element - item from MetaElements enum.
frankvnk 3:405462258899 153 //!
frankvnk 3:405462258899 154 //! \return None
frankvnk 3:405462258899 155 //!
frankvnk 3:405462258899 156 //! \brief Writes specific meta information to meta memory.
frankvnk 3:405462258899 157 //
frankvnk 3:405462258899 158 //*****************************************************************************
frankvnk 3:405462258899 159 void exosite_meta_read(unsigned char * read_buffer, unsigned short destBytes, unsigned char element)
frankvnk 3:405462258899 160 {
frankvnk 3:405462258899 161 exosite_meta * meta_info = 0;
frankvnk 3:405462258899 162
frankvnk 3:405462258899 163 switch (element)
frankvnk 3:405462258899 164 {
frankvnk 3:405462258899 165 case META_CIK:
frankvnk 3:405462258899 166 if (destBytes < META_CIK_SIZE) return;
frankvnk 3:405462258899 167 exoHAL_ReadMetaItem(read_buffer, destBytes, (int)meta_info->cik); //read CIK
frankvnk 3:405462258899 168 break;
frankvnk 3:405462258899 169 case META_SERVER:
frankvnk 3:405462258899 170 if (destBytes < META_SERVER_SIZE) return;
frankvnk 3:405462258899 171 exoHAL_ReadMetaItem(read_buffer, destBytes, (int)meta_info->server); //read server IP
frankvnk 3:405462258899 172 break;
frankvnk 3:405462258899 173 case META_MARK:
frankvnk 3:405462258899 174 if (destBytes < META_MARK_SIZE) return;
frankvnk 3:405462258899 175 exoHAL_ReadMetaItem(read_buffer, destBytes, (int)meta_info->mark); //read exosite mark
frankvnk 3:405462258899 176 break;
frankvnk 3:405462258899 177 case META_UUID:
frankvnk 3:405462258899 178 if (destBytes < META_UUID_SIZE) return;
frankvnk 3:405462258899 179 exoHAL_ReadMetaItem(read_buffer, destBytes, (int)meta_info->uuid); //read exosite mark
frankvnk 3:405462258899 180 break;
frankvnk 3:405462258899 181 case META_MFR:
frankvnk 3:405462258899 182 if (destBytes < META_MFR_SIZE) return;
frankvnk 3:405462258899 183 exoHAL_ReadMetaItem(read_buffer, destBytes, (int)meta_info->mfr); //read exosite mark
frankvnk 3:405462258899 184 break;
frankvnk 3:405462258899 185 case META_NONE:
frankvnk 3:405462258899 186 default:
frankvnk 3:405462258899 187 break;
frankvnk 3:405462258899 188 }
frankvnk 3:405462258899 189 return;
frankvnk 3:405462258899 190 }
frankvnk 3:405462258899 191
frankvnk 3:405462258899 192
frankvnk 3:405462258899 193