Telit Wireless Solutions GainSpan GS2200M, GS2101M Series Reference guide

  • Hello! I am an AI chatbot trained to assist you with the Telit Wireless Solutions GainSpan GS2200M Reference guide. I’ve already reviewed the document and can help you find the information you need or explain it in simple terms. Just ask your questions, and providing more details will help me assist you more effectively!
GS2200M
IP2WiFi Adapter Command
Reference Guide
1VV0301501 Rev. 1.0 – 2018-03-12
SPECIFICATIONS ARE SUBJECT TO CHANGE WITHOUT NOTICE
NOTICE
While reasonable efforts have been made to assure the accuracy of this document, Telit
assumes no liability resulting from any inaccuracies or omissions in this document, or from
use of the information obtained herein. The information in this document has been carefully
checked and is believed to be reliable. However, no responsibility is assumed for
inaccuracies or omissions. Telit reserves the right to make changes to any products described
herein and reserves the right to revise this document and to make changes from time to time
in content hereof with no obligation to notify any person of revisions or changes. Telit does not
assume any liability arising out of the application or use of any product, software, or circuit
described herein; neither does it convey license under its patent rights or the rights of others.
It is possible that this publication may contain references to, or information about Telit
products (machines and programs), programming, or services that are not announced in your
country. Such references or information must not be construed to mean that Telit intends to
announce such Telit products, programming, or services in your country.
COPYRIGHTS
This instruction manual and the Telit products described in this instruction manual may be,
include or describe copyrighted Telit material, such as computer programs stored in
semiconductor memories or other media. Laws in the Italy and other countries preserve for
Telit and its licensors certain exclusive rights for copyrighted material, including the exclusive
right to copy, reproduce in any form, distribute and make derivative works of the copyrighted
material. Accordingly, any copyrighted material of Telit and its licensor contained herein or in
the Telit products described in this instruction manual may not be copied, reproduced,
distributed, merged or modified in any manner without the express written permission of Telit.
Furthermore, the purchase of Telit products shall not be deemed to grant either directly or by
implication, estoppel, or otherwise, any license under the copyrights, patents or patent
applications of Telit, as arises by operation of law in the sale of a product.
COMPUTER SOFTWARE COPYRIGHTS
The Telit and 3rd Party supplied Software (SW) products described in this instruction manual
may include copyrighted Telit and other 3rd Party supplied computer programs stored in
semiconductor memories or other media. Laws in the Italy and other countries preserve for
Telit and other 3rd Party supplied SW certain exclusive rights for copyrighted computer pro-
grams, including the exclusive right to copy or reproduce in any form the copyrighted com-
puter program. Accordingly, any copyrighted Telit or other 3rd Party supplied SW computer
programs contained in the Telit products described in this instruction manual may not be cop-
ied (reverse engineered) or reproduced in any manner without the express written permission
of Telit or the 3rd Party SW supplier. Furthermore, the purchase of Telit products shall not be
deemed to grant either directly or by implication, estoppel, or otherwise, any license under the
copyrights, patents or patent applications of Telit or other 3rd Party supplied SW, except for
the normal non-exclusive, royalty free license to use that arises by operation of law in the sale
of a product.
USAGE AND DISCLOSURE RESTRICTIONS
I. License Agreements
The software described in this document is the property of Telit and its licensors. It is
furnished by express license agreement only and may be used only in accordance with the
terms of such an agreement.
II. Copyrighted Materials
Software and documentation are copyrighted materials. Making unauthorized copies is
prohibited by law. No part of the software or documentation may be reproduced, transmitted,
transcribed, stored in a retrieval system, or translated into any language or computer
language, in any form or by any means, without prior written permission of Telit
III. High Risk Materials
Components, units, or third-party products used in the product described herein are NOT
fault-tolerant and are NOT designed, manufactured, or intended for use as on-line control
equipment in the following hazardous environments requiring fail-safe controls: the operation
of Nuclear Facilities, Aircraft Navigation or Aircraft Communication Systems, Air Traffic
Control, Life Support, or Weapons Systems (High Risk Activities”). Telit and its supplier(s)
specifically disclaim any expressed or implied warranty of fitness for such High Risk Activities.
IV. Trademarks
TELIT and the Stylized T Logo are registered in Trademark Office. All other product or service
names are the property of their respective owners.
V. Third Party Rights
The software may include Third Party Right software. In this case you agree to comply with all
terms and conditions imposed on you in respect of such separate software. In addition to
Third Party Terms, the disclaimer of warranty and limitation of liability provisions in this
License shall apply to the Third Party Right software.
TELIT HEREBY DISCLAIMS ANY AND ALL WARRANTIES EXPRESS OR IMPLIED FROM
ANY THIRD PARTIES REGARDING ANY SEPARATE FILES, ANY THIRD PARTY
MATERIALS INCLUDED IN THE SOFTWARE, ANY THIRD PARTY MATERIALS FROM
WHICH THE SOFTWARE IS DERIVED (COLLECTIVELY “OTHER CODE”), AND THE USE
OF ANY OR ALL THE OTHER CODE IN CONNECTION WITH THE SOFTWARE,
INCLUDING (WITHOUT LIMITATION) ANY WARRANTIES OF SATISFACTORY QUALITY
OR FITNESS FOR A PARTICULAR PURPOSE.
NO THIRD PARTY LICENSORS OF OTHER CODE SHALL HAVE ANY LIABILITY FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED
AND WHETHER MADE UNDER CONTRACT, TORT OR OTHER LEGAL THEORY,
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE OTHER CODE OR
THE EXERCISE OF ANY RIGHTS GRANTED UNDER EITHER OR BOTH THIS LICENSE
AND THE LEGAL TERMS APPLICABLE TO ANY SEPARATE FILES, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGES.
PRODUCT
GS2200M
Software Release
5.5.2
APPLICABILITY TABLE
GS2200M IP2WiFi Adapter Command Reference Guide
1VV030 1501 Rev. 1.0 5 2018-03-12
Table of Contents
Chapter 1 Getting Started ................................................................................................................ 19
1.1 Overview ................................................................................................................................19
1.2 Using SDK Builder .................................................................................................................21
1.2.1 IP-to-WiFi Module Information .....................................................................................21
Chapter 2 Architecture ..................................................................................................................... 23
2.1 Overview ................................................................................................................................23
2.2 Serial Interface ......................................................................................................................24
2.3 System Initialization ...............................................................................................................24
2.3.1 Profile Definition ...........................................................................................................25
2.4 Command Processing Mode .................................................................................................26
2.5 Data Handling ........................................................................................................................27
2.5.1 Unsolicited/Unassociated/Beacon Mode Data Handling ..............................................28
2.5.2 Software Flow Control ..................................................................................................28
2.5.3 Hardware Flow Control ................................................................................................28
2.6 Serial Data Handling ..............................................................................................................29
2.7 Wireless Network Management .............................................................................................30
2.7.1 Scanning ......................................................................................................................30
2.7.2 Association ...................................................................................................................30
2.7.3 SSID and Passphrase ..................................................................................................30
Chapter 3 Host Interaction ............................................................................................................... 33
3.1 Startup Handling ....................................................................................................................34
3.1.1 Single Interface Startup Handling ................................................................................34
3.1.2 Dual Interface Startup Handling ...................................................................................35
3.2 Interface .................................................................................................................................35
3.2.1 UART ...........................................................................................................................35
3.2.1.1 UART Parameters ...............................................................................................35
3.2.1.2 Software Flow Control .........................................................................................37
3.2.1.3 Hardware Flow Control ........................................................................................38
3.2.2 SPI Interface and Configuration ...................................................................................39
3.2.2.1 SPI Byte Stuffing (Legacy SPI, SPI-NO-DMA) ....................................................40
3.2.2.2 SPI Command Response (SPI-DMA) ..................................................................41
3.2.2.3 Annexure - HI Frame Format (From Host) ...........................................................52
3.2.2.4 Annexure - HI Frame Response (From GS Node) ..............................................53
3.2.2.5 Pin Connection for SPI Interface .........................................................................54
3.2.3 SDIO Interface .............................................................................................................55
3.2.3.1 Capabilities ..........................................................................................................55
3.2.3.2 SDIO Host Slave Initialization and Communication .............................................56
3.2.3.3 SDIO Host Recommendations .............................................................................59
3.2.3.4 Pin Description .....................................................................................................61
3.2.4 Interface Verification ....................................................................................................61
Chapter 4 General Operations ......................................................................................................... 63
4.1 Version ..................................................................................................................................63
4.2 Time Setting ..........................................................................................................................65
4.2.1 Set System Time ..........................................................................................................65
4.2.1.1 Manual Setting .....................................................................................................65
4.2.2 Get System Time .........................................................................................................66
GS2200M IP2WiFi Adapter Command Reference Guide
1VV030 1501 Rev. 1.0 6 2018-03-12
4.3 Profile Setting ........................................................................................................................67
4.3.1 Get Profile ....................................................................................................................67
4.3.2 Save Profile ..................................................................................................................68
4.3.3 Load Profile ..................................................................................................................69
4.3.4 Select Default Profile ....................................................................................................70
4.3.5 Restore Profile .............................................................................................................71
4.3.6 Define Profile ................................................................................................................71
4.3.7 Identification Information ..............................................................................................73
4.3.8 Enhanced Asynchronous Notification ..........................................................................74
4.4 Reset .....................................................................................................................................75
4.5 MAC .......................................................................................................................................76
4.5.1 Set MAC Address .........................................................................................................76
4.5.2 Get MAC Address ........................................................................................................78
Chapter 5 Wireless ......................................................................................................................... 81
5.1 Wireless Generic ...................................................................................................................81
5.1.1 Regulatory Domain ......................................................................................................81
5.1.1.1 Set Regulatory Domain ........................................................................................81
5.1.1.2 Get Regulatory Domain .......................................................................................82
5.1.2 Operation Mode ...........................................................................................................83
5.1.3 MAC Retry ...................................................................................................................86
5.1.4 Sync Loss Interval ........................................................................................................87
5.1.5 Set RTS Threshold .......................................................................................................88
5.1.6 Transmit Data Rate ......................................................................................................89
5.1.6.1 Set Transmit Rate ................................................................................................89
5.1.6.2 Get Transmit Rate ...............................................................................................91
5.1.7 Graceful Shutdown of WLAN .......................................................................................92
5.2 Beacon Mode (Unassociated Mode) .....................................................................................93
5.2.1 Unassociated/Unsolicited Tx ........................................................................................93
5.2.2 Unassociated/Unsolicited Rx .......................................................................................98
5.2.2.1 Examples for Unassociated/Unsolicited Tx and Rx Commands ........................101
5.2.3 Unassociated/Unsolicited Rx Stop .............................................................................102
5.2.4 Unassociated/Unsolicited Data Encryption ................................................................103
5.3 Station/AP Mode ..................................................................................................................104
5.3.1 Scan Time Settings ....................................................................................................104
5.3.1.1 Set Scan Time ...................................................................................................104
5.3.1.2 Get Scan Time ...................................................................................................105
5.3.2 Authentication Mode ..................................................................................................106
5.3.3 Security Configuration ................................................................................................107
5.3.3.1 Security Setting ..................................................................................................107
5.3.3.2 WEP Keys ..........................................................................................................108
5.3.3.3 WEP Key Type Configuration ............................................................................109
5.3.3.4 WPA-PSK and WPA2-PSK Passphrase ............................................................111
5.3.3.5 WPA-PSK and WPA2-PSK Key Calculation ......................................................112
5.3.3.6 WPA-PSK and WPA2-PSK Key ........................................................................113
5.3.4 Scanning ....................................................................................................................115
5.3.5 Association .................................................................................................................117
5.3.6 Disassociation ............................................................................................................120
5.3.7 Connection Maintenance ...........................................................................................120
5.3.7.1 Keep Alive Timer ...............................................................................................120
5.3.7.2 WLAN Keep Alive Interval .................................................................................121
5.3.8 Advanced Commands ................................................................................................122
5.3.8.1 Get Client Information ........................................................................................122
5.4 WiFi Direct Mode .................................................................................................................123
GS2200M IP2WiFi Adapter Command Reference Guide
1VV030 1501 Rev. 1.0 7 2018-03-12
5.4.1 Set Device ..................................................................................................................123
5.4.2 Set WPS .....................................................................................................................125
5.4.3 Start Find ....................................................................................................................126
5.4.4 Stop Find ....................................................................................................................129
5.4.5 Provoke ......................................................................................................................130
5.4.6 Provision Discovery ....................................................................................................131
5.4.7 Group Form (Group Owner Negotiation) ....................................................................132
5.4.7.1 Provision Discovery Request Handling ..............................................................136
5.4.8 Client Join ..................................................................................................................138
5.4.9 Invitation Procedures .................................................................................................140
5.4.10 Disconnect ...............................................................................................................141
Chapter 6 Power Management - Radio and System ..................................................................... 143
6.1 Radio Receiver Setting ........................................................................................................143
6.1.1 Active Radio Receive .................................................................................................143
6.1.2 Standard Power Save Radio Receive based on DTIM/Listen Interval .......................145
6.1.2.1 IEEE PS Poll Listen Interval ..............................................................................145
6.1.3 Custom Power Save Radio Receive ..........................................................................148
6.2 Battery Measurement ..........................................................................................................149
6.2.1 Battery Check Start ....................................................................................................149
6.2.2 Battery Warning/Standby Level Set ...........................................................................150
6.2.3 Battery Check Set ......................................................................................................151
6.2.4 Battery Check Stop ....................................................................................................152
6.2.5 Battery Value Get .......................................................................................................152
6.3 System Power Save ............................................................................................................153
6.3.1 Hibernate ....................................................................................................................153
6.3.2 Standby ......................................................................................................................154
6.3.2.1 Putting the System in Standby ...........................................................................154
6.3.2.2 Enabling Standby Mode Between Beacons .......................................................156
6.3.2.3 Configuring Standby Between Beacons ............................................................157
6.3.3 Deep Sleep ................................................................................................................160
6.3.4 Power Save in Limited AP ..........................................................................................162
6.3.5 Hardware Cryptography .............................................................................................163
Chapter 7 Peripherals .................................................................................................................... 165
7.1 GPIO Commands ................................................................................................................165
7.1.1 GPIO Out HIGH/LOW ................................................................................................165
Chapter 8 Production and Debug .................................................................................................. 167
8.1 RF Test ................................................................................................................................167
8.1.1 Regulatory and Transmit Tests using RF Test Commands .......................................167
8.1.1.1 Regulatory Testing .............................................................................................167
8.1.1.2 Transmit Testing ................................................................................................167
8.1.1.3 Gain Control Table .............................................................................................168
8.1.1.4 Start RF Test .....................................................................................................168
8.1.1.5 Stop RF Test ......................................................................................................168
8.1.1.6 Asynchronous Frame Transmission ..................................................................168
8.1.1.7 Start Asynchronous Frame Reception ...............................................................170
8.1.1.8 Stop Asynchronous Frame Reception ...............................................................173
8.1.1.9 Asynchronous Frame Transmission (TX99 mode) ............................................174
8.1.1.10 Asynchronous Frame Transmission (TX100 mode) ........................................179
8.1.1.11 Carrier Wave Transmission .............................................................................181
8.2 Live Calibration ....................................................................................................................182
8.2.1 Enable Live Calibration ..............................................................................................182
GS2200M IP2WiFi Adapter Command Reference Guide
1VV030 1501 Rev. 1.0 8 2018-03-12
8.2.2 Erase Live Calibration ................................................................................................184
8.2.3 Start Live Calibration ..................................................................................................185
8.2.4 For Complete Sequence of Live Calibration ..............................................................187
8.3 Debug ..................................................................................................................................187
8.3.1 Log Level ....................................................................................................................187
8.3.2 Echo ...........................................................................................................................188
8.3.3 Verbose ......................................................................................................................189
8.3.4 RSSI ...........................................................................................................................190
8.3.5 WLAN Status ..............................................................................................................190
8.3.6 WLAN Statistics .........................................................................................................191
Appendix A Response Codes ........................................................................................................ 195
A.1 Synchronous Messages ......................................................................................................195
A.2 Asynchronous & Enhanced Asynchronous Messages ........................................................195
A.3.1 Exception Messages ..................................................................................................199
A.3.2 Boot Messages ..........................................................................................................200
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 9 2018-03-12
About This Manual
This manual provides guidelines for using the GainSpan
®
AT command-line interface to
design, configure, and provision the GS2200M series module to enable IP-to-WiFi
embedded devices with a UART/SPI interface to access an 802.11-compliant WiFi wireless
network connection using only serial commands.
Refer to the following sections:
Revision History, page 9
Audience, page 9
Standards, page 10
Documentation Conventions, page 10
Documentation, page 13
References, page 13
Contact Information, Support, page 15
Returning Products to GainSpan, page 16
Accessing the GainSpan Portal, page 16
Revision History
This revision history of the GainSpan IP-to-WiFi Adapter Application Programmer
Reference Guide is maintained in the following table:
Audience
This manual is designed for software engineers who want to evaluate, design, and
implement GainSpan Ultra Low Power 802.11 WiFi Modules within their environment. To
use this manual you will need a basic understanding of WiFi networks, network principles,
and network protocols.
Table 1 Revision History
Version Date Remarks
1.0 March2018 Initial Release
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 10 2018-03-12
Standards
The standards that are supported by the GainSpan GS module series are:
IEEE 802.11 b/g/n
Documentation Conventions
This manual uses the following text and syntax conventions:
Special text fonts represent particular commands, keywords, variables, or window
sessions
Color text indicates cross-reference hyper links to supplemental information
Command notation indicates commands, subcommands, or command elements
Table 2, page 10, describes the text conventions used in this manual for software
procedures that are explained using the AT command line interface.
Table 2 Document Text Conventions
Convention Type Description
command syntax
monospaced font
This monospaced font represents command strings entered on a
command line and sample source code.
AT XXXX
Proportional font
description
Gives specific details about a parameter.
<Data> DATA
UPPERCASE
Variable parameter
Indicates user input. Enter a value according to the descriptions that
follow. Each uppercased token expands into one or more other token.
lowercase
Keyword parameter
Indicates keywords. Enter values exactly as shown in the command
description.
[ ]
Square brackets
Enclose optional parameters. Choose none; or select one or more an
unlimited number of times each. Do not enter brackets as part of any
command.
[parm1|parm2|parm3]
?
Question mark
Used with the square brackets to limit the immediately following token
to one occurrence.
<ESC>
Escape sequence
Each escape sequence <ESC> starts with the ASCII character 27 (0x1B).
This is equivalent to the Escape key.
<ESC>C
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 11 2018-03-12
<CR>
Carriage return
Each command is terminated by a carriage return.
<LF>
Line feed
Each command is terminated by a line feed.
<CR> <LF>
Carriage return
Line feed
Each response is started with a carriage return and line feed with some
exceptions.
< >
Angle brackets
Enclose a numeric range, endpoints inclusive. Do not enter angle
brackets as part of any command.
<SSID>
=
Equal sign
Separates the variable from explanatory text. Is entered as part of the
command.
PROCESSID = <CID>
.
dot (period)
Allows the repetition of the element that immediately follows it multiple
times. Do not enter as part of the command.
.AA:NN can be expanded to 1:01 1:02 1:03.
A.B.C.D
IP address
IPv4-style address.
10.0.11.123
LINE
End-to-line input token
Indicates user input of any string, including spaces. No other parameters
may be entered after input for this token.
string of words
WORD
Single token
Indicates user input of any contiguous string (excluding spaces).
singlewordnospaces
Table 2 Document Text Conventions (Continued)
Convention Type Description
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 12 2018-03-12
Table 3, page 12, describes the symbol conventions used in this manual for notification and
important instructions.
Table 3 Symbol Conventions
Icon Type Description
Note
Provides helpful suggestions needed in understanding
a feature or references to material not available in the
manual.
Alert
Alerts you of potential damage to a program, device,
or system or the loss of data or service.
Caution
Cautions you about a situation that could result in
minor or moderate bodily injury if not avoided.
Warning
Warns you of a potential situation that could result in
death or serious bodily injury if not avoided.
Electro-Static Discharge
(ESD)
Notifies you to take proper grounding precautions
before handling a product.
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 13 2018-03-12
Documentation
The GainSpan documentation suite listed in Table 4, page 13 includes the part number,
documentation name, and a description of the document. The documents are available from
the GainSpan Portal. Refer to Accessing the GainSpan Portal, page 16 for details.
Documentation Feedback
We encourage you to provide feedback, comments, and suggestions so that we can improve
the documentation. You can send your comments by logging into Telit Support Portal. If
you are using e-mail, be sure to include the following information with your comments:
Document name
URL or page number
Hardware release version (if applicable)
Software release version (if applicable)
References
The GainSpan references listed in Table 5, page 14 are available on the GainSpan Portal.
Refer to Accessing the GainSpan Portal, page 16 for details.
Table 4 Documentation List
Part Number Document Title Description
1VV0301396
GS2200M Low Power WiFi Mini-Module Hardware User
Guide
Provides information to help WiFi
system designers to build systems using
GainSpan GS2200M module and
develop wireless applications.
1VV0301444
GS2K S2W Use Case Reference Guide
Provides references for using GainSpan
AT commands and its usage in different
scenarios using different features and
protocols.
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 14 2018-03-12
Table 5 Other Documents and References
Title Description
Schematics
GS Based Module Evaluation Board schematics
supporting:
GS2200M
Module Firmware and
Programming Utilities
IP-to-WiFi (IP2WiFi) based firmware
Firmware Release Notes
GSFlashprogram utility for programming the
modules
Software Utilities
Serial terminal program to evaluate and demonstrate
IP-to-WiFi (IP2WiFi) applications such as
gs2k_flashprogram.exe
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 15 2018-03-12
Contact Information, Support
For general contact, technical support services, technical questions and to report
documentation errors contact Telit Technical Support at:
We recommend adding “Wi-Fi” in subject of the email. For example, the subject of email
can be “Wi-Fi: Your actual issue or question in brief” like “Wi-Fi: SPI Driver Issue”.
Also, in description of your email, please provide details about the issue, product and
module including software firmware version, module version and type, application being
used, customizations done to application, use case, issue frequency, and ability to recreate
it among other things wherever applicable.
Alternatively, for more Technical Support information or assistance, perform the following
steps:
1. Visit http://www.telit.com, go to Products> Wi-Fi and Blue-tooth, then scroll down to
the Telit Wi- Fi Portal.
2. Click Access the Portal Here icon which will direct you to the GainSpan portal
http://www.gainspan/secure/login.com
1. Log in with your customer Email and Password.
2. Select the Location.
3. Select Q&A tab.
4. Select Ask a New Question.
5. Enter your technical support question, product information, and a brief description.
For detailed information about where you can buy the Telit modules or for
recommendations on accessories and components visit:
http://www.telit.com
Our aim is to make this guide as helpful as possible. Keep us informed of your comments
and suggestions for improvements. Telit appreciates feedback from the users of our
information.
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 16 2018-03-12
Returning Products to GainSpan
If a problem cannot be resolved by GainSpan technical support, a Return Material
Authorization (RMA) is issued. This number is used to track the returned material at the
factory and to return repaired or new components to the customer as needed.
To return a hardware component:
1. Determine the part number and serial number of the component.
2. Obtain an RMA number from Sales/Distributor Representative.
3. Provide the following information in an e-mail or during the telephone call:
Part number and serial number of component
Your name, organization name, telephone number, and fax number
Description of the failure
4. The support representative validates your request and issues an RMA number for
return of the components.
5. Pack the component for shipment.
Guidelines for Packing Components for Shipment
To pack and ship individual components:
When you return components, make sure they are adequately protected with
packing materials and packed so that the pieces are prevented from moving
around inside the carton.
Use the original shipping materials if they are available.
Place individual components in electrostatic bags.
Write the RMA number on the exterior of the box to ensure proper tracking.
Accessing the GainSpan Portal
To find the latest version of GainSpan documentation supporting the GainSpan product
release you are interested in, you can search the GainSpan Portal website by performing the
following steps:
NOTE: Do not return any components to GainSpan Corporation unless you have
first obtained an RMA number. GainSpan reserves the right to refuse shipments
that do not have an RMA. Refused shipments will be returned to the customer by
collect freight.
CAUTION! Do not stack any of the components.
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 17 2018-03-12
1. Visit http://www.telit.com, go to Products> Wi-Fi and Blue-tooth, then scroll down
the Telit Wi- Fi Portal.
2. Click Access the Portal Here icon which will direct you to the GainSpan portal
http://www.gainspan/secure/login.com
3. Log in using your customer Email and Password.
4. Click the Getting Started tab to view a Quick Start tutorial on how to use various
features within the GainSpan Portal.
5. Click the Agreements tab to download and upload the SLA for ADK and SDK
respectively.
6. Click on the Documents tab to search, download, and print GainSpan product
documentation.
7. Click the Software tab to search and download the latest software versions.
8. Click the Kits Purchased tab to view customer account history.
9. Click the Legal Documents tab to view GainSpan Non-Disclosure Agreement
(NDA).
10. Click the Certifications tab to view GainSpan certifications.
NOTE: You must first contact GainSpan to set up an account, and obtain a
customer user name and password before you can access the GainSpan Portal.
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 18 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 19 2018-03-12
Chapter 1 Getting Started
This chapter describes how to get started.
Overview, page 19
Using SDK Builder, page 21
1.1 Overview
The IP-to-WiFi stack is used to provide WiFi capability to any device having a serial
interface. This approach offloads WLAN, TCP/IP stack and network management
overhead to the WiFi chip, allowing a small embedded host (for example an MCU) to
communicate with other hosts on the network using a WiFi wireless link. The host
processor can use serial commands to configure the IP-to-WiFi Application and to create
wireless and network connections.
OTP stands for One Time Programmable Memory. It is divided into two parts, one for
Application firmware and another for WLAN firmware. It contains important system
related information for Application and WLAN firmware. For Application firmware, it
contains information about MAC address, regularity information, module related
information, and so on. For WLAN firmware, it contains information about calibration
data.
The user will have to register on GainSpan website, sign the NDA and check with the local
sales team for any queries during this procedure. This gives access to all the respective
documentation according to the product purchased.
The following is the basic application development sequence for a IP-to-WiFi user.
1. Evaluate GainSpan hardware and firmware
Download the software, program, and execute.
To download the software, go to SDK builder (www.gainspan.com/secure/login),
and download all the latest packages including the binary (Refer GS2K SDK
Builder User Guide).
Flash the binary using module programmer user guide on the custom hardware or
GS evaluation board and execute in RUN mode. (Refer “GS2K Module
Programming User Guide”).
2. Design the custom hardware by following the design guidelines. (Refer GS2xxxM
Hardware Design Guidelines)
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 20 2018-03-12
3. Develop Host firmware
Following Live Calibrations commands are highly recommended to be issued
before doing any Wi-Fi operations:
AT+WLCALERASE
AT+RESET
AT+WLCALSTART=1
Interface host application using AT commands. (Refer GS2xxxM S2W Adapter
Command Reference Guide)
Configure the serial interface (UART/SPI/SDIO) as required, refer UART,
page 35, SPI Interface and Configuration, page 39 and SDIO Interface, page 55 for
mode, polarity.For software interface, choose Command & Response, Byte
stuffing/de-stuffing as “None” for UART and SDIO options.
Issue general, power save, and security related commands as required.
Start connection to an Access Point or do provisioning as required.
Obtain IP Address and Start Data Transfer.
Select advanced services if any.
4. Debug Host and GainSpan module
Debug using provided AT commands and other options if required. (Refer
GS2xxxM S2W Adapter Command Reference Guide)
Analyze using Wire shark over wireless. For more details, refer information about
AirPcap Nx in http://www.riverbed.com
5. Production Process
Perform generic recommendations in production line
Check if Live Calibration needs to be explicitly controlled (rarely used),
Perform RF tests
NOTE: For desired functionality use appropriate AT Commands. Refer “GS2K
S2W Reference Use Case User Guide”
NOTE: Refer to “GS2K S2W Reference Use Case User Guide” document for
detailed use cases and examples.
/