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

Dependencies:   NVIC_set_all_priorities mbed cc3000_hostdriver_mbedsocket TEMT6200 TSI Wi-Go_eCompass_Lib_V3 WiGo_BattCharger

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

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
OrangeErase all wireless profiles
PurpleSmartConfig
BlueWebServer
RedExosite Data Client
GreenAndroid Server

Swipe your index finger across the slider pad, the RGB LED color will change at approximately 20% 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 Oct 23 12:01:30 2013 +0000
Revision:
1:99bfc8d68fd3
Webserver functional using ProcessWlanInterrupt flag instead of NVIC

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 1:99bfc8d68fd3 1 /*****************************************************************************
frankvnk 1:99bfc8d68fd3 2 *
frankvnk 1:99bfc8d68fd3 3 * C++ interface/implementation created by Martin Kojtal (0xc0170). Thanks to
frankvnk 1:99bfc8d68fd3 4 * Jim Carver and Frank Vannieuwkerke for their inital cc3000 mbed port and
frankvnk 1:99bfc8d68fd3 5 * provided help.
frankvnk 1:99bfc8d68fd3 6 *
frankvnk 1:99bfc8d68fd3 7 * This version of "host driver" uses CC3000 Host Driver Implementation. Thus
frankvnk 1:99bfc8d68fd3 8 * read the following copyright:
frankvnk 1:99bfc8d68fd3 9 *
frankvnk 1:99bfc8d68fd3 10 * Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
frankvnk 1:99bfc8d68fd3 11 *
frankvnk 1:99bfc8d68fd3 12 * Redistribution and use in source and binary forms, with or without
frankvnk 1:99bfc8d68fd3 13 * modification, are permitted provided that the following conditions
frankvnk 1:99bfc8d68fd3 14 * are met:
frankvnk 1:99bfc8d68fd3 15 *
frankvnk 1:99bfc8d68fd3 16 * Redistributions of source code must retain the above copyright
frankvnk 1:99bfc8d68fd3 17 * notice, this list of conditions and the following disclaimer.
frankvnk 1:99bfc8d68fd3 18 *
frankvnk 1:99bfc8d68fd3 19 * Redistributions in binary form must reproduce the above copyright
frankvnk 1:99bfc8d68fd3 20 * notice, this list of conditions and the following disclaimer in the
frankvnk 1:99bfc8d68fd3 21 * documentation and/or other materials provided with the
frankvnk 1:99bfc8d68fd3 22 * distribution.
frankvnk 1:99bfc8d68fd3 23 *
frankvnk 1:99bfc8d68fd3 24 * Neither the name of Texas Instruments Incorporated nor the names of
frankvnk 1:99bfc8d68fd3 25 * its contributors may be used to endorse or promote products derived
frankvnk 1:99bfc8d68fd3 26 * from this software without specific prior written permission.
frankvnk 1:99bfc8d68fd3 27 *
frankvnk 1:99bfc8d68fd3 28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
frankvnk 1:99bfc8d68fd3 29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
frankvnk 1:99bfc8d68fd3 30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
frankvnk 1:99bfc8d68fd3 31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
frankvnk 1:99bfc8d68fd3 32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
frankvnk 1:99bfc8d68fd3 33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
frankvnk 1:99bfc8d68fd3 34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
frankvnk 1:99bfc8d68fd3 35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
frankvnk 1:99bfc8d68fd3 36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
frankvnk 1:99bfc8d68fd3 37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
frankvnk 1:99bfc8d68fd3 38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
frankvnk 1:99bfc8d68fd3 39 *
frankvnk 1:99bfc8d68fd3 40 *****************************************************************************/
frankvnk 1:99bfc8d68fd3 41 #ifndef CC3000_EVENT_H
frankvnk 1:99bfc8d68fd3 42 #define CC3000_EVENT_H
frankvnk 1:99bfc8d68fd3 43
frankvnk 1:99bfc8d68fd3 44 typedef struct _bsd_read_return_t
frankvnk 1:99bfc8d68fd3 45 {
frankvnk 1:99bfc8d68fd3 46 int32_t iSocketDescriptor;
frankvnk 1:99bfc8d68fd3 47 int32_t iNumberOfBytes;
frankvnk 1:99bfc8d68fd3 48 uint32_t uiFlags;
frankvnk 1:99bfc8d68fd3 49 } tBsdReadReturnParams;
frankvnk 1:99bfc8d68fd3 50
frankvnk 1:99bfc8d68fd3 51 typedef struct _bsd_getsockopt_return_t
frankvnk 1:99bfc8d68fd3 52 {
frankvnk 1:99bfc8d68fd3 53 uint8_t ucOptValue[4];
frankvnk 1:99bfc8d68fd3 54 uint8_t iStatus;
frankvnk 1:99bfc8d68fd3 55 } tBsdGetSockOptReturnParams;
frankvnk 1:99bfc8d68fd3 56
frankvnk 1:99bfc8d68fd3 57 typedef struct _bsd_accept_return_t
frankvnk 1:99bfc8d68fd3 58 {
frankvnk 1:99bfc8d68fd3 59 int32_t iSocketDescriptor;
frankvnk 1:99bfc8d68fd3 60 int32_t iStatus;
frankvnk 1:99bfc8d68fd3 61 sockaddr tSocketAddress;
frankvnk 1:99bfc8d68fd3 62
frankvnk 1:99bfc8d68fd3 63 } tBsdReturnParams;
frankvnk 1:99bfc8d68fd3 64
frankvnk 1:99bfc8d68fd3 65 typedef struct _bsd_select_return_t
frankvnk 1:99bfc8d68fd3 66 {
frankvnk 1:99bfc8d68fd3 67 int32_t iStatus;
frankvnk 1:99bfc8d68fd3 68 uint32_t uiRdfd;
frankvnk 1:99bfc8d68fd3 69 uint32_t uiWrfd;
frankvnk 1:99bfc8d68fd3 70 uint32_t uiExfd;
frankvnk 1:99bfc8d68fd3 71 } tBsdSelectRecvParams;
frankvnk 1:99bfc8d68fd3 72
frankvnk 1:99bfc8d68fd3 73 typedef struct _bsd_gethostbyname_return_t
frankvnk 1:99bfc8d68fd3 74 {
frankvnk 1:99bfc8d68fd3 75 int32_t retVal;
frankvnk 1:99bfc8d68fd3 76 int32_t outputAddress;
frankvnk 1:99bfc8d68fd3 77 } tBsdGethostbynameParams;
frankvnk 1:99bfc8d68fd3 78
frankvnk 1:99bfc8d68fd3 79 #define FLOW_CONTROL_EVENT_HANDLE_OFFSET (0)
frankvnk 1:99bfc8d68fd3 80 #define FLOW_CONTROL_EVENT_BLOCK_MODE_OFFSET (1)
frankvnk 1:99bfc8d68fd3 81 #define FLOW_CONTROL_EVENT_FREE_BUFFS_OFFSET (2)
frankvnk 1:99bfc8d68fd3 82 #define FLOW_CONTROL_EVENT_SIZE (4)
frankvnk 1:99bfc8d68fd3 83
frankvnk 1:99bfc8d68fd3 84 #define BSD_RSP_PARAMS_SOCKET_OFFSET (0)
frankvnk 1:99bfc8d68fd3 85 #define BSD_RSP_PARAMS_STATUS_OFFSET (4)
frankvnk 1:99bfc8d68fd3 86
frankvnk 1:99bfc8d68fd3 87 #define GET_HOST_BY_NAME_RETVAL_OFFSET (0)
frankvnk 1:99bfc8d68fd3 88 #define GET_HOST_BY_NAME_ADDR_OFFSET (4)
frankvnk 1:99bfc8d68fd3 89
frankvnk 1:99bfc8d68fd3 90 #define ACCEPT_SD_OFFSET (0)
frankvnk 1:99bfc8d68fd3 91 #define ACCEPT_RETURN_STATUS_OFFSET (4)
frankvnk 1:99bfc8d68fd3 92 #define ACCEPT_ADDRESS__OFFSET (8)
frankvnk 1:99bfc8d68fd3 93
frankvnk 1:99bfc8d68fd3 94 #define SL_RECEIVE_SD_OFFSET (0)
frankvnk 1:99bfc8d68fd3 95 #define SL_RECEIVE_NUM_BYTES_OFFSET (4)
frankvnk 1:99bfc8d68fd3 96 #define SL_RECEIVE__FLAGS__OFFSET (8)
frankvnk 1:99bfc8d68fd3 97
frankvnk 1:99bfc8d68fd3 98
frankvnk 1:99bfc8d68fd3 99 #define SELECT_STATUS_OFFSET (0)
frankvnk 1:99bfc8d68fd3 100 #define SELECT_READFD_OFFSET (4)
frankvnk 1:99bfc8d68fd3 101 #define SELECT_WRITEFD_OFFSET (8)
frankvnk 1:99bfc8d68fd3 102 #define SELECT_EXFD_OFFSET (12)
frankvnk 1:99bfc8d68fd3 103
frankvnk 1:99bfc8d68fd3 104
frankvnk 1:99bfc8d68fd3 105 #define NETAPP_IPCONFIG_IP_OFFSET (0)
frankvnk 1:99bfc8d68fd3 106 #define NETAPP_IPCONFIG_SUBNET_OFFSET (4)
frankvnk 1:99bfc8d68fd3 107 #define NETAPP_IPCONFIG_GW_OFFSET (8)
frankvnk 1:99bfc8d68fd3 108 #define NETAPP_IPCONFIG_DHCP_OFFSET (12)
frankvnk 1:99bfc8d68fd3 109 #define NETAPP_IPCONFIG_DNS_OFFSET (16)
frankvnk 1:99bfc8d68fd3 110 #define NETAPP_IPCONFIG_MAC_OFFSET (20)
frankvnk 1:99bfc8d68fd3 111 #define NETAPP_IPCONFIG_SSID_OFFSET (26)
frankvnk 1:99bfc8d68fd3 112
frankvnk 1:99bfc8d68fd3 113 #define NETAPP_IPCONFIG_IP_LENGTH (4)
frankvnk 1:99bfc8d68fd3 114 #define NETAPP_IPCONFIG_MAC_LENGTH (6)
frankvnk 1:99bfc8d68fd3 115 #define NETAPP_IPCONFIG_SSID_LENGTH (32)
frankvnk 1:99bfc8d68fd3 116
frankvnk 1:99bfc8d68fd3 117
frankvnk 1:99bfc8d68fd3 118 #define NETAPP_PING_PACKETS_SENT_OFFSET (0)
frankvnk 1:99bfc8d68fd3 119 #define NETAPP_PING_PACKETS_RCVD_OFFSET (4)
frankvnk 1:99bfc8d68fd3 120 #define NETAPP_PING_MIN_RTT_OFFSET (8)
frankvnk 1:99bfc8d68fd3 121 #define NETAPP_PING_MAX_RTT_OFFSET (12)
frankvnk 1:99bfc8d68fd3 122 #define NETAPP_PING_AVG_RTT_OFFSET (16)
frankvnk 1:99bfc8d68fd3 123
frankvnk 1:99bfc8d68fd3 124 #define GET_SCAN_RESULTS_TABlE_COUNT_OFFSET (0)
frankvnk 1:99bfc8d68fd3 125 #define GET_SCAN_RESULTS_SCANRESULT_STATUS_OFFSET (4)
frankvnk 1:99bfc8d68fd3 126 #define GET_SCAN_RESULTS_ISVALID_TO_SSIDLEN_OFFSET (8)
frankvnk 1:99bfc8d68fd3 127 #define GET_SCAN_RESULTS_FRAME_TIME_OFFSET (10)
frankvnk 1:99bfc8d68fd3 128 #define GET_SCAN_RESULTS_SSID_MAC_LENGTH (38)
frankvnk 1:99bfc8d68fd3 129
frankvnk 1:99bfc8d68fd3 130 #define M_BSD_RESP_PARAMS_OFFSET(hci_event_hdr)((uint8_t *)(hci_event_hdr) + HCI_EVENT_HEADER_SIZE)
frankvnk 1:99bfc8d68fd3 131
frankvnk 1:99bfc8d68fd3 132 #define SOCKET_STATUS_ACTIVE 0
frankvnk 1:99bfc8d68fd3 133 #define SOCKET_STATUS_INACTIVE 1
frankvnk 1:99bfc8d68fd3 134 /* Init socket_active_status = 'all ones': init all sockets with SOCKET_STATUS_INACTIVE.
frankvnk 1:99bfc8d68fd3 135 Will be changed by 'set_socket_active_status' upon 'connect' and 'accept' calls */
frankvnk 1:99bfc8d68fd3 136 #define SOCKET_STATUS_INIT_VAL 0xFFFF
frankvnk 1:99bfc8d68fd3 137 #define M_IS_VALID_SD(sd) ((0 <= (sd)) && ((sd) <= 7))
frankvnk 1:99bfc8d68fd3 138 #define M_IS_VALID_STATUS(status) (((status) == SOCKET_STATUS_ACTIVE)||((status) == SOCKET_STATUS_INACTIVE))
frankvnk 1:99bfc8d68fd3 139
frankvnk 1:99bfc8d68fd3 140 #define BSD_RECV_FROM_FROMLEN_OFFSET (4)
frankvnk 1:99bfc8d68fd3 141 #define BSD_RECV_FROM_FROM_OFFSET (16)
frankvnk 1:99bfc8d68fd3 142
frankvnk 1:99bfc8d68fd3 143 #endif