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:
9:5d431f47ac93
faster i2c (375KHz)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 0:a8e46e27d041 1 /****************************************************************************
frankvnk 0:a8e46e27d041 2 *
frankvnk 0:a8e46e27d041 3 * doTCPIP.h - CC3000 TCP/IP
frankvnk 0:a8e46e27d041 4 * Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
frankvnk 0:a8e46e27d041 5 *
frankvnk 0:a8e46e27d041 6 * Redistribution and use in source and binary forms, with or without
frankvnk 0:a8e46e27d041 7 * modification, are permitted provided that the following conditions
frankvnk 0:a8e46e27d041 8 * are met:
frankvnk 0:a8e46e27d041 9 *
frankvnk 0:a8e46e27d041 10 * Redistributions of source code must retain the above copyright
frankvnk 0:a8e46e27d041 11 * notice, this list of conditions and the following disclaimer.
frankvnk 0:a8e46e27d041 12 *
frankvnk 0:a8e46e27d041 13 * Redistributions in binary form must reproduce the above copyright
frankvnk 0:a8e46e27d041 14 * notice, this list of conditions and the following disclaimer in the
frankvnk 0:a8e46e27d041 15 * documentation and/or other materials provided with the
frankvnk 0:a8e46e27d041 16 * distribution.
frankvnk 0:a8e46e27d041 17 *
frankvnk 0:a8e46e27d041 18 * Neither the name of Texas Instruments Incorporated nor the names of
frankvnk 0:a8e46e27d041 19 * its contributors may be used to endorse or promote products derived
frankvnk 0:a8e46e27d041 20 * from this software without specific prior written permission.
frankvnk 0:a8e46e27d041 21 *
frankvnk 0:a8e46e27d041 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
frankvnk 0:a8e46e27d041 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
frankvnk 0:a8e46e27d041 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
frankvnk 0:a8e46e27d041 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
frankvnk 0:a8e46e27d041 26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
frankvnk 0:a8e46e27d041 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
frankvnk 0:a8e46e27d041 28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
frankvnk 0:a8e46e27d041 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
frankvnk 0:a8e46e27d041 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
frankvnk 0:a8e46e27d041 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
frankvnk 0:a8e46e27d041 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
frankvnk 0:a8e46e27d041 33 *
frankvnk 0:a8e46e27d041 34 *****************************************************************************/
frankvnk 0:a8e46e27d041 35
frankvnk 0:a8e46e27d041 36 #ifndef DOTCPIP_H
frankvnk 0:a8e46e27d041 37 #define DOTCPIP_H
frankvnk 0:a8e46e27d041 38
frankvnk 0:a8e46e27d041 39 #include "cc3000.h"
frankvnk 3:405462258899 40 #include "Wi-Go_eCompass_Lib_V3.h"
frankvnk 0:a8e46e27d041 41
frankvnk 0:a8e46e27d041 42 /** TCP/IP Functions
frankvnk 0:a8e46e27d041 43 *
frankvnk 0:a8e46e27d041 44 */
frankvnk 0:a8e46e27d041 45 #ifdef __cplusplus
frankvnk 0:a8e46e27d041 46 extern "C" {
frankvnk 0:a8e46e27d041 47 #endif
frankvnk 0:a8e46e27d041 48
frankvnk 0:a8e46e27d041 49 #ifndef FALSE
frankvnk 0:a8e46e27d041 50 #define FALSE 0
frankvnk 0:a8e46e27d041 51 #endif
frankvnk 0:a8e46e27d041 52
frankvnk 0:a8e46e27d041 53 #ifndef TRUE
frankvnk 0:a8e46e27d041 54 #define TRUE 1
frankvnk 0:a8e46e27d041 55 #endif
frankvnk 0:a8e46e27d041 56
frankvnk 0:a8e46e27d041 57 #define SMART_CONFIG_SET 0x55
frankvnk 3:405462258899 58 // SMTP Specific
frankvnk 3:405462258899 59 #define HTTP_PORT 80
frankvnk 3:405462258899 60 #define TCPIP_PORT 15000
frankvnk 0:a8e46e27d041 61
frankvnk 0:a8e46e27d041 62 #define USE_DHCP 1
frankvnk 0:a8e46e27d041 63 #define USE_STATIC_IP 2
frankvnk 0:a8e46e27d041 64
frankvnk 0:a8e46e27d041 65 #define NONE 0
frankvnk 0:a8e46e27d041 66 #define WEP 1
frankvnk 0:a8e46e27d041 67 #define WPA 2
frankvnk 0:a8e46e27d041 68 #define WPA2 3
frankvnk 0:a8e46e27d041 69
frankvnk 0:a8e46e27d041 70 // Modify the following settings as necessary for your Wi-Fi Network setup:
frankvnk 0:a8e46e27d041 71 #define IP_ALLOC_METHOD USE_DHCP // for DHCP assigned IP address
frankvnk 0:a8e46e27d041 72 //#define IP_ALLOC_METHOD USE_STATIC_IP // for static IP address
frankvnk 0:a8e46e27d041 73
frankvnk 0:a8e46e27d041 74 // Default SSID Settings
frankvnk 3:405462258899 75 //#define AP_KEY "thisthis"
frankvnk 3:405462258899 76 //#define AP_SECURITY WPA2 // WPA2 must be enabled for use with iPhone or Android phone hotspot!
frankvnk 0:a8e46e27d041 77 #define SSID "iot"
frankvnk 0:a8e46e27d041 78 #define AP_SECURITY NONE // no security but will connect quicker!
frankvnk 0:a8e46e27d041 79 #define STATIC_IP_OCT1 192
frankvnk 0:a8e46e27d041 80 #define STATIC_IP_OCT2 168
frankvnk 0:a8e46e27d041 81 #define STATIC_IP_OCT3 0
frankvnk 0:a8e46e27d041 82 #define STATIC_IP_OCT4 10
frankvnk 0:a8e46e27d041 83
frankvnk 1:32d1ef95eceb 84 #define STATIC_GW_OCT4 1 // Static Gateway address = STATIC_IP_OCT1.STATIC_IP_OCT2.STATIC_IP_OCT3.STATIC_GW_OCT4
frankvnk 1:32d1ef95eceb 85
frankvnk 0:a8e46e27d041 86 #define REQ_BUFFER_SIZE 400
frankvnk 0:a8e46e27d041 87
frankvnk 0:a8e46e27d041 88 typedef struct {
frankvnk 0:a8e46e27d041 89 unsigned char FTC; // First time config performed
frankvnk 0:a8e46e27d041 90 unsigned char PP_version[2]; // Patch Programmer version
frankvnk 0:a8e46e27d041 91 unsigned char SERV_PACK[2]; // Service Pack Version
frankvnk 0:a8e46e27d041 92 unsigned char DRV_VER[3]; // Driver Version
frankvnk 0:a8e46e27d041 93 unsigned char FW_VER[3]; // Firmware Version
frankvnk 0:a8e46e27d041 94 unsigned char validCIK; // CIK[] is valid (Client Interface Key)
frankvnk 0:a8e46e27d041 95 unsigned char CIK[40];
frankvnk 0:a8e46e27d041 96 } userFS_t;
frankvnk 0:a8e46e27d041 97
frankvnk 0:a8e46e27d041 98 extern userFS_t userFS;
frankvnk 0:a8e46e27d041 99
frankvnk 5:6546c5b92897 100 extern volatile unsigned long ulSmartConfigFinished,ulCC3000DHCP, OkToDoShutDown, ulCC3000DHCP_configured;
frankvnk 3:405462258899 101 extern int server_running;
frankvnk 0:a8e46e27d041 102 extern volatile unsigned char newData;
frankvnk 0:a8e46e27d041 103 extern unsigned char ForceFixedSSID;
frankvnk 0:a8e46e27d041 104 extern char runSmartConfig;
frankvnk 0:a8e46e27d041 105 extern char requestBuffer[];
frankvnk 0:a8e46e27d041 106 extern unsigned char myMAC[8];
frankvnk 0:a8e46e27d041 107 extern unsigned char SmartConfigProfilestored;
frankvnk 3:405462258899 108 extern int do_mDNS;
frankvnk 3:405462258899 109 extern axis6_t axis6;
frankvnk 3:405462258899 110 extern int HsecondFlag;
frankvnk 3:405462258899 111 extern unsigned int seconds;
frankvnk 0:a8e46e27d041 112
frankvnk 0:a8e46e27d041 113 extern void StartSmartConfig(void);
frankvnk 0:a8e46e27d041 114
frankvnk 0:a8e46e27d041 115
frankvnk 3:405462258899 116 int sendTCPIP(int port);
frankvnk 0:a8e46e27d041 117 void sendPython(int port);
frankvnk 0:a8e46e27d041 118 void initTCPIP(void);
frankvnk 0:a8e46e27d041 119 void runTCPIPserver(void);
frankvnk 3:405462258899 120 int getTCPIP( char a1, char a2, char a3, char a4, int port);
frankvnk 3:405462258899 121 void runTCPIPclient(int a1, int a2, int a3, int a4);
frankvnk 0:a8e46e27d041 122
frankvnk 0:a8e46e27d041 123 /** Checks if WiFi is still connected.
frankvnk 0:a8e46e27d041 124 * @param None
frankvnk 0:a8e46e27d041 125 * @return TRUE if connected, FALSE if not
frankvnk 0:a8e46e27d041 126 * @note If not associated with an AP for 5 consecutive retries, it will reset the board.
frankvnk 0:a8e46e27d041 127 */
frankvnk 0:a8e46e27d041 128 unsigned char checkWiFiConnected(void);
frankvnk 0:a8e46e27d041 129
frankvnk 0:a8e46e27d041 130 /** Print MAC address.
frankvnk 0:a8e46e27d041 131 * @param None
frankvnk 0:a8e46e27d041 132 * @return none
frankvnk 0:a8e46e27d041 133 */
frankvnk 0:a8e46e27d041 134 void print_mac(void);
frankvnk 0:a8e46e27d041 135
frankvnk 0:a8e46e27d041 136 /** First time configuration.
frankvnk 0:a8e46e27d041 137 * @param None
frankvnk 0:a8e46e27d041 138 * @return none
frankvnk 0:a8e46e27d041 139 */
frankvnk 0:a8e46e27d041 140 void do_FTC(void);
frankvnk 0:a8e46e27d041 141
frankvnk 0:a8e46e27d041 142 #ifdef __cplusplus
frankvnk 0:a8e46e27d041 143 }
frankvnk 0:a8e46e27d041 144 #endif // __cplusplus
frankvnk 0:a8e46e27d041 145
frankvnk 0:a8e46e27d041 146 #endif // DOTCPIP_H
frankvnk 2:13ced2cb5933 147
frankvnk 9:5d431f47ac93 148