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 Color | Application to Launch |
Orange | Erase all wireless profiles |
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 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 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.
cc3000_hostdriver_mbedsocket/cc3000_spi.h
- Committer:
- frankvnk
- Date:
- 2013-10-23
- Revision:
- 1:99bfc8d68fd3
- Child:
- 3:1851b5d6f69d
File content as of revision 1:99bfc8d68fd3:
/***************************************************************************** * * C++ interface/implementation created by Martin Kojtal (0xc0170). Thanks to * Jim Carver and Frank Vannieuwkerke for their inital cc3000 mbed port and * provided help. * * This version of "host driver" uses CC3000 Host Driver Implementation. Thus * read the following copyright: * * 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. * *****************************************************************************/ #ifndef CC3000_SPI_H #define CC3000_SPI_H extern volatile bool ProcessWlanInterrupt; typedef struct { uint16_t tx_packet_length; uint16_t rx_packet_length; uint32_t spi_state; } tSpiInfo; /* =========================================================================================== SPI =========================================================================================== */ #define READ 3 #define WRITE 1 #define HI(value) (((value) & 0xFF00) >> 8) #define LO(value) ((value) & 0x00FF) #define HEADERS_SIZE_EVNT (SPI_HEADER_SIZE + 5) #define SPI_HEADER_SIZE (5) #define eSPI_STATE_POWERUP (0) #define eSPI_STATE_INITIALIZED (1) #define eSPI_STATE_IDLE (2) #define eSPI_STATE_WRITE_IRQ (3) #define eSPI_STATE_WRITE_FIRST_PORTION (4) #define eSPI_STATE_WRITE_EOT (5) #define eSPI_STATE_READ_IRQ (6) #define eSPI_STATE_READ_FIRST_PORTION (7) #define eSPI_STATE_READ_EOT (8) // The magic number that resides at the end of the TX/RX buffer (1 byte after the allocated size) // for the purpose of detection of the overrun. The location of the memory where the magic number // resides shall never be written. In case it is written - overrun occured and either recevie function // or send function will be stuck forever. #define CC3000_BUFFER_MAGIC_NUMBER (0xDE) /* =========================================================================================== HCI =========================================================================================== */ #define SL_PATCH_PORTION_SIZE (1000) #define SPI_HEADER_SIZE (5) #define SIMPLE_LINK_HCI_CMND_HEADER_SIZE (4) #define HEADERS_SIZE_CMD (SPI_HEADER_SIZE + SIMPLE_LINK_HCI_CMND_HEADER_SIZE) #define SIMPLE_LINK_HCI_DATA_CMND_HEADER_SIZE (5) #define SIMPLE_LINK_HCI_DATA_HEADER_SIZE (5) #define SIMPLE_LINK_HCI_PATCH_HEADER_SIZE (2) // Values that can be used as HCI Commands and HCI Packet header defines #define HCI_TYPE_CMND 0x1 #define HCI_TYPE_DATA 0x2 #define HCI_TYPE_PATCH 0x3 #define HCI_TYPE_EVNT 0x4 #define HCI_EVENT_PATCHES_DRV_REQ (1) #define HCI_EVENT_PATCHES_FW_REQ (2) #define HCI_EVENT_PATCHES_BOOTLOAD_REQ (3) #define HCI_CMND_WLAN_BASE (0x0000) #define HCI_CMND_WLAN_CONNECT 0x0001 #define HCI_CMND_WLAN_DISCONNECT 0x0002 #define HCI_CMND_WLAN_IOCTL_SET_SCANPARAM 0x0003 #define HCI_CMND_WLAN_IOCTL_SET_CONNECTION_POLICY 0x0004 #define HCI_CMND_WLAN_IOCTL_ADD_PROFILE 0x0005 #define HCI_CMND_WLAN_IOCTL_DEL_PROFILE 0x0006 #define HCI_CMND_WLAN_IOCTL_GET_SCAN_RESULTS 0x0007 #define HCI_CMND_EVENT_MASK 0x0008 #define HCI_CMND_WLAN_IOCTL_STATUSGET 0x0009 #define HCI_CMND_WLAN_IOCTL_SIMPLE_CONFIG_START 0x000A #define HCI_CMND_WLAN_IOCTL_SIMPLE_CONFIG_STOP 0x000B #define HCI_CMND_WLAN_IOCTL_SIMPLE_CONFIG_SET_PREFIX 0x000C #define HCI_CMND_WLAN_CONFIGURE_PATCH 0x000D #define HCI_CMND_SOCKET_BASE 0x1000 #define HCI_CMND_SOCKET 0x1001 #define HCI_CMND_BIND 0x1002 #define HCI_CMND_RECV 0x1004 #define HCI_CMND_ACCEPT 0x1005 #define HCI_CMND_LISTEN 0x1006 #define HCI_CMND_CONNECT 0x1007 #define HCI_CMND_BSD_SELECT 0x1008 #define HCI_CMND_SETSOCKOPT 0x1009 #define HCI_CMND_GETSOCKOPT 0x100A #define HCI_CMND_CLOSE_SOCKET 0x100B #define HCI_CMND_RECVFROM 0x100D #define HCI_CMND_GETHOSTNAME 0x1010 #define HCI_CMND_MDNS_ADVERTISE 0x1011 #define HCI_DATA_BASE 0x80 #define HCI_CMND_SEND (0x01 + HCI_DATA_BASE) #define HCI_CMND_SENDTO (0x03 + HCI_DATA_BASE) #define HCI_DATA_BSD_RECVFROM (0x04 + HCI_DATA_BASE) #define HCI_DATA_BSD_RECV (0x05 + HCI_DATA_BASE) #define HCI_CMND_NVMEM_CBASE (0x0200) #define HCI_CMND_NVMEM_CREATE_ENTRY (0x0203) #define HCI_CMND_NVMEM_SWAP_ENTRY (0x0205) #define HCI_CMND_NVMEM_READ (0x0201) #define HCI_CMND_NVMEM_WRITE (0x0090) #define HCI_CMND_NVMEM_WRITE_PATCH (0x0204) #define HCI_CMND_READ_SP_VERSION (0x0207) #define HCI_CMND_READ_BUFFER_SIZE 0x400B #define HCI_CMND_SIMPLE_LINK_START 0x4000 #define HCI_CMND_NETAPP_BASE 0x2000 #define HCI_NETAPP_DHCP (0x0001 + HCI_CMND_NETAPP_BASE) #define HCI_NETAPP_PING_SEND (0x0002 + HCI_CMND_NETAPP_BASE) #define HCI_NETAPP_PING_REPORT (0x0003 + HCI_CMND_NETAPP_BASE) #define HCI_NETAPP_PING_STOP (0x0004 + HCI_CMND_NETAPP_BASE) #define HCI_NETAPP_IPCONFIG (0x0005 + HCI_CMND_NETAPP_BASE) #define HCI_NETAPP_ARP_FLUSH (0x0006 + HCI_CMND_NETAPP_BASE) #define HCI_NETAPP_SET_DEBUG_LEVEL (0x0008 + HCI_CMND_NETAPP_BASE) #define HCI_NETAPP_SET_TIMERS (0x0009 + HCI_CMND_NETAPP_BASE) // Values that can be used as HCI Events defines #define HCI_EVNT_WLAN_BASE 0x0000 #define HCI_EVNT_WLAN_CONNECT 0x0001 #define HCI_EVNT_WLAN_DISCONNECT \ 0x0002 #define HCI_EVNT_WLAN_IOCTL_ADD_PROFILE \ 0x0005 #define HCI_EVNT_SOCKET HCI_CMND_SOCKET #define HCI_EVNT_BIND HCI_CMND_BIND #define HCI_EVNT_RECV HCI_CMND_RECV #define HCI_EVNT_ACCEPT HCI_CMND_ACCEPT #define HCI_EVNT_LISTEN HCI_CMND_LISTEN #define HCI_EVNT_CONNECT HCI_CMND_CONNECT #define HCI_EVNT_SELECT HCI_CMND_BSD_SELECT #define HCI_EVNT_CLOSE_SOCKET HCI_CMND_CLOSE_SOCKET #define HCI_EVNT_RECVFROM HCI_CMND_RECVFROM #define HCI_EVNT_SETSOCKOPT HCI_CMND_SETSOCKOPT #define HCI_EVNT_GETSOCKOPT HCI_CMND_GETSOCKOPT #define HCI_EVNT_BSD_GETHOSTBYNAME HCI_CMND_GETHOSTNAME #define HCI_EVNT_MDNS_ADVERTISE HCI_CMND_MDNS_ADVERTISE #define HCI_EVNT_SEND 0x1003 #define HCI_EVNT_WRITE 0x100E #define HCI_EVNT_SENDTO 0x100F #define HCI_EVNT_PATCHES_REQ 0x1000 #define HCI_EVNT_UNSOL_BASE 0x4000 #define HCI_EVNT_WLAN_UNSOL_BASE (0x8000) #define HCI_EVNT_WLAN_UNSOL_CONNECT (0x0001 + HCI_EVNT_WLAN_UNSOL_BASE) #define HCI_EVNT_WLAN_UNSOL_DISCONNECT (0x0002 + HCI_EVNT_WLAN_UNSOL_BASE) #define HCI_EVNT_WLAN_UNSOL_INIT (0x0004 + HCI_EVNT_WLAN_UNSOL_BASE) #define HCI_EVNT_WLAN_TX_COMPLETE (0x0008 + HCI_EVNT_WLAN_UNSOL_BASE) #define HCI_EVNT_WLAN_UNSOL_DHCP (0x0010 + HCI_EVNT_WLAN_UNSOL_BASE) #define HCI_EVNT_WLAN_ASYNC_PING_REPORT (0x0040 + HCI_EVNT_WLAN_UNSOL_BASE) #define HCI_EVNT_WLAN_ASYNC_SIMPLE_CONFIG_DONE (0x0080 + HCI_EVNT_WLAN_UNSOL_BASE) #define HCI_EVNT_WLAN_KEEPALIVE (0x0200 + HCI_EVNT_WLAN_UNSOL_BASE) #define HCI_EVNT_BSD_TCP_CLOSE_WAIT (0x0800 + HCI_EVNT_WLAN_UNSOL_BASE) #define HCI_EVNT_DATA_UNSOL_FREE_BUFF \ 0x4100 #define HCI_EVNT_NVMEM_CREATE_ENTRY \ HCI_CMND_NVMEM_CREATE_ENTRY #define HCI_EVNT_NVMEM_SWAP_ENTRY HCI_CMND_NVMEM_SWAP_ENTRY #define HCI_EVNT_NVMEM_READ HCI_CMND_NVMEM_READ #define HCI_EVNT_NVMEM_WRITE (0x0202) #define HCI_EVNT_READ_SP_VERSION \ HCI_CMND_READ_SP_VERSION #define HCI_EVNT_INPROGRESS 0xFFFF #define HCI_DATA_RECVFROM 0x84 #define HCI_DATA_RECV 0x85 #define HCI_DATA_NVMEM 0x91 #define HCI_EVENT_CC3000_CAN_SHUT_DOWN 0x99 // Prototypes for the structures for HCI APIs. #define HCI_DATA_HEADER_SIZE (5) #define HCI_EVENT_HEADER_SIZE (5) #define HCI_DATA_CMD_HEADER_SIZE (5) #define HCI_PATCH_HEADER_SIZE (6) #define HCI_PACKET_TYPE_OFFSET (0) #define HCI_PACKET_ARGSIZE_OFFSET (2) #define HCI_PACKET_LENGTH_OFFSET (3) #define HCI_EVENT_OPCODE_OFFSET (1) #define HCI_EVENT_LENGTH_OFFSET (3) #define HCI_EVENT_STATUS_OFFSET (4) #define HCI_DATA_LENGTH_OFFSET (3) #endif