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
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 ifCC3000_MAXIMAL_RX_SIZE
is set to(511 + 1)
incc3000_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 Color | Application to Launch |
Purple | SmartConfig |
Blue | WebServer |
Red | Exosite Data Client |
Green | Android 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 Color | Direction Indication |
Blue | Near to North |
Green | North |
Red | East / West |
Purple | South |
__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 |
D1 | is the board heartbeat, derived from the timer interrupt |
D2 | indicates 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 |
D3 | WLAN 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 inti\CC3000AndroidApp\SmartConfigCC3X\bin
.
- iOS app : available at Apple app store.
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:
- 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
Select a supported device | Wi-Go |
Enter device MAC Address | nn: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.
- 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:
Enter WiGo's IP address |
Enter the SSID (of the Hot-Spot or Wireless Access Point used by Wi-Go) |
- 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.
Diff: Webserver/httpserver.cpp
- Revision:
- 3:405462258899
- Child:
- 6:7c06ad22f206
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Webserver/httpserver.cpp Sat Sep 07 15:41:49 2013 +0000 @@ -0,0 +1,399 @@ +/**************************************************************************** +* +* httpserver.c - General HTTP Server implementation +* 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. +* +*****************************************************************************/ + +#include "httpserver.h" +#include "doTCPIP.h" +#include "TSISensor.h" + +extern axis6_t axis6; +extern TSISensor tsi; + +/** \brief Socket used by server to listen and accept connections */ +long httpServerSocket; + +/** \brief Variable holding the server's port */ +int serverPort = 0; + +/** \brief Pointer to the index HTML page */ +char * indexPage; +extern unsigned char *dataPacket; + +/** \brief Pointer to CGI handler structure */ +cgi_handler * chList; + +/** \brief Pointer to Dynamic HTML handler structure */ +dyn_html_handler * htmlList; + +/** \brief Pointer to Dynamic HTML handler structure */ +http_server_event_handler * eventHandlers = NULL; + + +/** \brief Client socket handle list */ +int clientList[MAX_CLIENTS]; + +/** \brief Page view counter */ +int viewCounter = 1; +#define REQ_BUFFER_SIZE 400 // +#define HTTP_TX_BLOCK_SIZE 256 // + + +extern char requestBuffer[REQ_BUFFER_SIZE]; + + +volatile int Delay; + +//extern char OkToDoShutDown; +//extern int newData, secondFlag, ms5Flag; + +/********************************************************************/ +void getAccelXYZ_Str(char * str) // MMA8451Q accelerometer - report axis with highest value +{ + sprintf(str," "); //clears field (needed if previous string had more characters) + sprintf(str, "X= %1.2f, Y= %1.2f, Z= %1.2f", axis6.fGax, axis6.fGay, axis6.fGaz);; +} + +/********************************************************************/ +void getTemperatureStr(char * str) // +{ + sprintf(str, "%+d C", axis6.temp); +} + +/********************************************************************/ +void getTSI_sliderStr(char * str) // TSI Slider position +{ + uint8_t slider_position; + + slider_position = tsi.readPercentage() * 100; // Slider position as percentage + sprintf(str," "); //clears field (needed if previous string had more characters) + sprintf(str, "%d %%", slider_position); +} + +void getCompassStr(char * str) // Mag3110 generated Compass bearing +{ + char *compass_points[9] = {"North", "N-East", "East", "S-East", "South", "S-West", "West", "N-West", "North"}; + signed short compass_bearing = (axis6.compass + 23) / 45; + sprintf(str," "); //clears field (needed if previous string had more characters) + sprintf(str, "Roll=%-d Pitch=%-d Yaw=%-d [%s]", axis6.roll, axis6.pitch, axis6.yaw, compass_points[compass_bearing]); // +} + +void getM3110Str(char * str) // Mag3110 displayed in units of UT +{ + sprintf(str," "); //clears field (needed if previous string had more characters) + sprintf(str, "X= %3.1f, Y= %3.1f, Z= %3.1f", axis6.fUTmx, axis6.fUTmy, axis6.fUTmz); +} + +/********************************************************************/ +extern void getAltitudeStr(char * str) // Get Altitude +{ + sprintf(str, "%+d meters", axis6.alt); // str = integer portion of result +} + +//***************************************************************************** +// +//! \brief Initializes HTTP Server +//! +//! \param cnum is the client socket handle to be used +//! +//! \return 0 if successful +//! +// +//***************************************************************************** +char initHTTPServer(int port, + char * ipage, + cgi_handler * handleList, + dyn_html_handler * dhList) +{ + sockaddr serverSocketAddr; + serverPort = port; + indexPage = ipage; + chList = handleList; + htmlList = dhList; + + + httpServerSocket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP); + if (httpServerSocket == -1) + { + printf("oops\n"); + wlan_stop(); + return(-1); + } + + serverSocketAddr.sa_family = AF_INET; + + // Set the Port Number + serverSocketAddr.sa_data[0] = (port & 0xFF00)>> 8; + serverSocketAddr.sa_data[1] = (port & 0x00FF); + + memset (&serverSocketAddr.sa_data[2], 0, 4); + + if (bind(httpServerSocket, &serverSocketAddr, sizeof(sockaddr)) != 0); + + return 0; +} + +//***************************************************************************** +// +//! \brief Main HTTP Server +//! +//! \param none +//! +//! \return none +//! +// +//***************************************************************************** +void serverMain() +{ + sockaddr clientaddr; + socklen_t addrlen; + int i = 0; + int currentClient = 0; + printf("Main HTTP server\n"); + for(i = 0; i < MAX_CLIENTS; i++) + clientList[i] = -1; + + // Start Listening + if (listen (httpServerSocket, MAX_CLIENTS) != 0); + + // Handle Clients and Data + while(1) + { + addrlen = sizeof(clientaddr); + printf("Current Client= %d\n", currentClient); + // accept blocks until we receive a connection + //LED_D2_ON; + ms5Flag = 0; + while ( (clientList[currentClient] == -1) || (clientList[currentClient] == -2) ) + { + clientList[currentClient] = accept(httpServerSocket, (sockaddr *) &clientaddr, &addrlen); + } + + if(clientList[currentClient] >= 0) + { + // Connection Accepted, Send Data + // Wait for a data update + newData = 0; + while(!newData); + SysTick->CTRL &= ~SysTick_CTRL_TICKINT_Msk; // *** Disable SysTick Timer + handleHTTPRequest(currentClient); + closesocket(clientList[currentClient]); + clientList[currentClient]=-1; + wait_us(40); + } + else if(clientList[currentClient] == -57) + { + // BUG: Socket inactive so reopen socket + // Inactive Socket, close and reopen it + printf("Oops!!!\n"); + closesocket(httpServerSocket); + httpServerSocket = 0xFFFFFFFF; + initHTTPServer(serverPort, indexPage, chList, htmlList); + // Start Listening + if ( listen (httpServerSocket, 5) != 0 ); + } + SysTick->CTRL |= SysTick_CTRL_TICKINT_Msk; // *** Re-Enable SysTick Timer + } +} + +//***************************************************************************** +// +//! \brief Handles HTTP Requests +//! +//! \param cnum is the client socket handle to be used +//! +//! \return none +//! +// +//***************************************************************************** +void handleHTTPRequest(int cnum) +{ + + char * reqline[3]; + char * cgiTok; + + int i = 0; + char paramBuf[20]; + int bytesRecvd; + char tempStr[40]; //PF was 26 + + memset(requestBuffer,0,sizeof (requestBuffer)); + bytesRecvd = recv(clientList[cnum], requestBuffer, sizeof(requestBuffer), 0); + + printf("\nhandleHTTPRequest\n"); + + if(bytesRecvd > 0) + { + // Received some data, check it and send data back + reqline[0] = strstr(requestBuffer, "GET"); + if ( reqline[0] != NULL ) + { + if (strstr (requestBuffer, "HTTP/1.0") != NULL && strstr (requestBuffer, "HTTP/1.1") != NULL ) + { + send(clientList[cnum], "HTTP/1.0 400 Bad Request\n", 25,0); + } + else + { + +#ifdef HTTP_CGI_ENABLED + // Do we have CGI parameters we need to parse? + if(strchr(requestBuffer, '?') != NULL) + { + // Decode URL and handle each parameter sequentially + // according to table previously setup. + cgiTok = strstr(requestBuffer,"="); + if(cgiTok != NULL) + { + memset(paramBuf,0,sizeof(paramBuf)); + memcpy(paramBuf,cgiTok+1,5); // hard-coded for demo: 5 character parameter (-Red-/Green/Blue-) + chList->cgiHandlerFunc[0](paramBuf); + + } + } +#endif + +#ifdef HTTP_DYN_HTML_ENABLED + // The code below replaces data in the HTML page + // with that generated by the specified functions. + for(i = 0; i < 9; i++) // change the range here for more dynamic fields on webpage + { + memset(tempStr,0,sizeof(tempStr)); + htmlList->dynHtmlFunc[i](tempStr); + tempStr[strlen(tempStr)]= ' '; + pageReplace((char *)indexPage, + (char *)htmlList->dynHtmlParamName[i], + (char *)tempStr); + } +#endif + viewCounter++; + + sendHTTPData(clientList[cnum], HTTP_RESP, strlen(HTTP_RESP)); + + for(i = 0; i < strlen(indexPage); i += HTTP_TX_BLOCK_SIZE) + { + + if(strlen(indexPage) - i < HTTP_TX_BLOCK_SIZE) + { + sendHTTPData(clientList[cnum], &indexPage[i], strlen(indexPage) - i); + } + else + { + sendHTTPData(clientList[cnum], &indexPage[i], HTTP_TX_BLOCK_SIZE); + } + // This delay is necessary, or else we run into issues + for (Delay = 0; Delay < 1000; Delay++); //PF + } + } + } + } +} + +//***************************************************************************** +// +//! \brief Inserts characters in page that appear after an indicator ind +//! with the value from val +//! +//! \param page is a pointer to the array holding the page's HTML code +//! \param ind is a pointer to a string that has the name of the parameter on the page to modify +//! \param val is the pointer to a string holding the string to insert in the XXX +//! +//! \return none +//! +// +//***************************************************************************** +void pageReplace(char * page, char * ind, char * val) +{ + char * indicLoc; + indicLoc = strstr (page,ind); + memcpy(indicLoc+strlen(ind), val, strlen(val)); +} + +//***************************************************************************** +// +//! \brief Returns a string with the number of views of the page +//! +//! \param str is a pointer to the array where the number of views will be put +//! +//! \return none +//! +// +//***************************************************************************** +extern uint32 cal_count; + + +void getViewsNum(char * str) +{ + sprintf(str, "%d", viewCounter); +} + +//***************************************************************************** +// +//! \brief Sends HTTP Data +//! +//! \param sdesc is the socket descriptor of the socket used for sending data +//! \param buf is a pointer to the buffer with the data to be sent +//! \param len is the number of bytes to send +//! +//! \return none +//! +// +//***************************************************************************** +void sendHTTPData(long sdesc, const void *buf, long len) +{ + int bytesSent = -2; + while(bytesSent == -2) bytesSent = send(sdesc, buf, len,0); + if(bytesSent == -1) + { + // General Send Error + } + if (bytesSent != strlen(indexPage)) + { + // ERROR: not all bytes sent + } +} + +//***************************************************************************** +// +//! \brief Initializes HTTP Server Event Handler +//! +//! \param eh is a pointer to the array handling server events +//! +//! \return none +//! +// +//***************************************************************************** +void initEventHandlers(http_server_event_handler * eh) +{ + eventHandlers = eh; +} +