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:
Sat Feb 28 20:23:30 2015 +0000
Revision:
7:9d86d022fa68
Parent:
4:8f8d0d19e6f1
Fixed Webserver lockup by skipping all code in the SysTick_Handler while HTTP data is sent.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 4:8f8d0d19e6f1 1 #ifndef RUN_EXOSITE_H
frankvnk 4:8f8d0d19e6f1 2 #define RUN_EXOSITE_H
frankvnk 4:8f8d0d19e6f1 3
frankvnk 4:8f8d0d19e6f1 4 #include "TCPSocketConnection.h"
frankvnk 4:8f8d0d19e6f1 5 #include "TCPSocketServer.h"
frankvnk 4:8f8d0d19e6f1 6
frankvnk 4:8f8d0d19e6f1 7 extern cc3000 wifi;
frankvnk 4:8f8d0d19e6f1 8 extern tUserFS user_info;
frankvnk 4:8f8d0d19e6f1 9
frankvnk 4:8f8d0d19e6f1 10 #ifdef __cplusplus
frankvnk 4:8f8d0d19e6f1 11 extern "C" {
frankvnk 4:8f8d0d19e6f1 12 #endif
frankvnk 4:8f8d0d19e6f1 13
frankvnk 4:8f8d0d19e6f1 14 #include <stdint.h>
frankvnk 4:8f8d0d19e6f1 15
frankvnk 4:8f8d0d19e6f1 16 void run_exosite(TCPSocketConnection *socket);
frankvnk 4:8f8d0d19e6f1 17
frankvnk 4:8f8d0d19e6f1 18 // defines
frankvnk 4:8f8d0d19e6f1 19 enum UUIDInterfaceTypes
frankvnk 4:8f8d0d19e6f1 20 {
frankvnk 4:8f8d0d19e6f1 21 IF_WIFI,
frankvnk 4:8f8d0d19e6f1 22 IF_ENET,
frankvnk 4:8f8d0d19e6f1 23 IF_FILE,
frankvnk 4:8f8d0d19e6f1 24 IF_HDD,
frankvnk 4:8f8d0d19e6f1 25 IF_I2C,
frankvnk 4:8f8d0d19e6f1 26 IF_GPRS,
frankvnk 4:8f8d0d19e6f1 27 IF_NONE
frankvnk 4:8f8d0d19e6f1 28 };
frankvnk 4:8f8d0d19e6f1 29
frankvnk 4:8f8d0d19e6f1 30 enum ExositeStatusCodes
frankvnk 4:8f8d0d19e6f1 31 {
frankvnk 4:8f8d0d19e6f1 32 EXO_STATUS_OK,
frankvnk 4:8f8d0d19e6f1 33 EXO_STATUS_INIT,
frankvnk 4:8f8d0d19e6f1 34 EXO_STATUS_BAD_UUID,
frankvnk 4:8f8d0d19e6f1 35 EXO_STATUS_BAD_VENDOR,
frankvnk 4:8f8d0d19e6f1 36 EXO_STATUS_BAD_MODEL,
frankvnk 4:8f8d0d19e6f1 37 EXO_STATUS_BAD_INIT,
frankvnk 4:8f8d0d19e6f1 38 EXO_STATUS_BAD_TCP,
frankvnk 4:8f8d0d19e6f1 39 EXO_STATUS_BAD_SN,
frankvnk 4:8f8d0d19e6f1 40 EXO_STATUS_CONFLICT,
frankvnk 4:8f8d0d19e6f1 41 EXO_STATUS_BAD_CIK,
frankvnk 4:8f8d0d19e6f1 42 EXO_STATUS_NOAUTH,
frankvnk 4:8f8d0d19e6f1 43 EXO_STATUS_END
frankvnk 4:8f8d0d19e6f1 44 };
frankvnk 4:8f8d0d19e6f1 45
frankvnk 4:8f8d0d19e6f1 46 #define EXOSITE_VENDOR_MAXLENGTH 20
frankvnk 4:8f8d0d19e6f1 47 #define EXOSITE_MODEL_MAXLENGTH 20
frankvnk 4:8f8d0d19e6f1 48 #define EXOSITE_SN_MAXLENGTH EXOSITE_HAL_SN_MAXLENGTH
frankvnk 4:8f8d0d19e6f1 49 #define EXOSITE_DEMO_UPDATE_INTERVAL 4000// ms
frankvnk 4:8f8d0d19e6f1 50 #define CIK_LENGTH 40
frankvnk 4:8f8d0d19e6f1 51
frankvnk 4:8f8d0d19e6f1 52 // -------------- META --------------
frankvnk 4:8f8d0d19e6f1 53 // defines
frankvnk 4:8f8d0d19e6f1 54 #define META_SIZE 256
frankvnk 4:8f8d0d19e6f1 55 #define META_CIK_SIZE 40
frankvnk 4:8f8d0d19e6f1 56 #define META_SERVER_SIZE 6
frankvnk 4:8f8d0d19e6f1 57 #define META_PAD0_SIZE 2
frankvnk 4:8f8d0d19e6f1 58 #define META_MARK_SIZE 8
frankvnk 4:8f8d0d19e6f1 59 #define META_UUID_SIZE 17
frankvnk 4:8f8d0d19e6f1 60 #define META_PAD1_SIZE 4
frankvnk 4:8f8d0d19e6f1 61 #define META_RSVD_SIZE 56
frankvnk 4:8f8d0d19e6f1 62 #define META_MFR_SIZE 128
frankvnk 4:8f8d0d19e6f1 63 typedef struct {
frankvnk 4:8f8d0d19e6f1 64 char cik[META_CIK_SIZE]; // our client interface key
frankvnk 4:8f8d0d19e6f1 65 char server[META_SERVER_SIZE]; // ip address of m2.exosite.com (not using DNS at this stage)
frankvnk 4:8f8d0d19e6f1 66 char pad0[META_PAD0_SIZE]; // pad 'server' to 8 bytes
frankvnk 4:8f8d0d19e6f1 67 char mark[META_MARK_SIZE]; // watermark
frankvnk 4:8f8d0d19e6f1 68 char uuid[META_UUID_SIZE]; // UUID in ascii
frankvnk 4:8f8d0d19e6f1 69 char pad1[META_PAD1_SIZE]; // pad 'uuid' to 16 bytes
frankvnk 4:8f8d0d19e6f1 70 char rsvd[META_RSVD_SIZE]; // reserved space - pad to ensure mfr is at end of RDK_META_SIZE
frankvnk 4:8f8d0d19e6f1 71 char mfr[META_MFR_SIZE]; // manufacturer data structure
frankvnk 4:8f8d0d19e6f1 72 } exosite_meta;
frankvnk 4:8f8d0d19e6f1 73
frankvnk 4:8f8d0d19e6f1 74 #define EXOMARK "exosite!"
frankvnk 4:8f8d0d19e6f1 75
frankvnk 4:8f8d0d19e6f1 76 typedef enum
frankvnk 4:8f8d0d19e6f1 77 {
frankvnk 4:8f8d0d19e6f1 78 META_CIK,
frankvnk 4:8f8d0d19e6f1 79 META_SERVER,
frankvnk 4:8f8d0d19e6f1 80 META_MARK,
frankvnk 4:8f8d0d19e6f1 81 META_UUID,
frankvnk 4:8f8d0d19e6f1 82 META_MFR,
frankvnk 4:8f8d0d19e6f1 83 META_NONE
frankvnk 4:8f8d0d19e6f1 84 } MetaElements;
frankvnk 4:8f8d0d19e6f1 85
frankvnk 4:8f8d0d19e6f1 86
frankvnk 4:8f8d0d19e6f1 87 // -------------- HAL --------------
frankvnk 4:8f8d0d19e6f1 88 // defines
frankvnk 4:8f8d0d19e6f1 89 /*typedef enum
frankvnk 4:8f8d0d19e6f1 90 {
frankvnk 4:8f8d0d19e6f1 91 IF_WIFI,
frankvnk 4:8f8d0d19e6f1 92 IF_ENET,
frankvnk 4:8f8d0d19e6f1 93 IF_FILE,
frankvnk 4:8f8d0d19e6f1 94 IF_HDD,
frankvnk 4:8f8d0d19e6f1 95 IF_I2C,
frankvnk 4:8f8d0d19e6f1 96 IF_NONE
frankvnk 4:8f8d0d19e6f1 97 } UUIDInterfaceTypes;*/
frankvnk 4:8f8d0d19e6f1 98
frankvnk 4:8f8d0d19e6f1 99 typedef enum
frankvnk 4:8f8d0d19e6f1 100 {
frankvnk 4:8f8d0d19e6f1 101 EXO_ERROR_WRITE,
frankvnk 4:8f8d0d19e6f1 102 EXO_ERROR_READ,
frankvnk 4:8f8d0d19e6f1 103 EXO_ERROR_CONNECT,
frankvnk 4:8f8d0d19e6f1 104 EXO_ERROR_UNKNOWN,
frankvnk 4:8f8d0d19e6f1 105 EXO_ERROR_END
frankvnk 4:8f8d0d19e6f1 106 } ExositeErrorCodes;
frankvnk 4:8f8d0d19e6f1 107
frankvnk 4:8f8d0d19e6f1 108 typedef enum
frankvnk 4:8f8d0d19e6f1 109 {
frankvnk 4:8f8d0d19e6f1 110 EXO_SERVER_CONNECTED,
frankvnk 4:8f8d0d19e6f1 111 EXO_CLIENT_RW,
frankvnk 4:8f8d0d19e6f1 112 EXO_UI_END
frankvnk 4:8f8d0d19e6f1 113 } ExositeUICodes;
frankvnk 4:8f8d0d19e6f1 114
frankvnk 4:8f8d0d19e6f1 115 #ifdef __cplusplus
frankvnk 4:8f8d0d19e6f1 116 }
frankvnk 4:8f8d0d19e6f1 117 #endif // __cplusplus
frankvnk 4:8f8d0d19e6f1 118
frankvnk 4:8f8d0d19e6f1 119 #endif // RUN_EXOSITE_H
frankvnk 4:8f8d0d19e6f1 120