Telit Wireless Solutions GS2200M, GS2101M Series Reference Manual
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 programs, including the exclusive right to copy or reproduce in any form the copyrighted computer 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 copied (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.
APPLICABILITY TABLE
PRODUCT
GS2200M
Software Release
5.5.2
GS2200M IP2WiFi Adapter Command Reference Guide
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
1VV030 1501 Rev. 1.0 5 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
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
1VV030 1501 Rev. 1.0 6 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
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
1VV030 1501 Rev. 1.0 7 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
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
1VV030 1501 Rev. 1.0 8 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
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:
Table 1 Revision History
Version Date Remarks
1.0 March2018 Initial Release
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.
1VV0301501 Rev. 1.0 9 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
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
This monospaced font represents command strings entered on a
command syntax
command line and sample source code.
monospaced font
AT XXXX
Proportional font
description
UPPERCASE
Gives specific details about a parameter.
<Data> DATA
Indicates user input. Enter a value according to the descriptions that
follow. Each uppercased token expands into one or more other token.
Variable parameter
lowercase
Indicates keywords. Enter values exactly as shown in the command
description.
Keyword parameter
Enclose optional parameters. Choose none; or select one or more an
[ ]
Square brackets
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.
Each escape sequence <ESC> starts with the ASCII character 27 (0x1B).
<ESC>
This is equivalent to the Escape key.
Escape sequence
<ESC>C
1VV0301501 Rev. 1.0 10 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
Table 2 Document Text Conventions (Continued)
Convention Type Description
<CR>
Carriage return
<LF>
Line feed
<CR> <LF>
Carriage return
Line feed
< >
Angle brackets
=
Equal sign
.
dot (period)
A.B.C.D
IP address
Each command is terminated by a carriage return.
Each command is terminated by a line feed.
Each response is started with a carriage return and line feed with some
exceptions.
Enclose a numeric range, endpoints inclusive. Do not enter angle
brackets as part of any command.
<SSID>
Separates the variable from explanatory text. Is entered as part of the
command.
PROCESSID = <CID>
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.
IPv4-style address.
10.0.11.123
LINE
End-to-line input token
WORD
Single token
Indicates user input of any string, including spaces. No other parameters
may be entered after input for this token.
string of words
Indicates user input of any contiguous string (excluding spaces).
singlewordnospaces
1VV0301501 Rev. 1.0 11 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
Table 3, page 12, describes the symbol conventions used in this manual for notification and
important instructions.
Table 3 Symbol Conventions
Icon Type Description
Provides helpful suggestions needed in understanding
Note
a feature or references to material not available in the
manual.
Alert
Caution
Warning
Electro-Static Discharge
(ESD)
Alerts you of potential damage to a program, device,
or system or the loss of data or service.
Cautions you about a situation that could result in
minor or moderate bodily injury if not avoided.
Warns you of a potential situation that could result in
death or serious bodily injury if not avoided.
Notifies you to take proper grounding precautions
before handling a product.
1VV0301501 Rev. 1.0 12 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
Documentation
Part Number Document Title Description
1VV0301396
1VV0301444
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.
Table 4 Documentation List
Provides information to help WiFi
GS2200M Low Power WiFi Mini-Module Hardware User
Guide
GS2K S2W Use Case Reference Guide
system designers to build systems using
GainSpan GS2200M module and
develop wireless applications.
Provides references for using GainSpan
AT commands and its usage in different
scenarios using different features and
protocols.
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.
1VV0301501 Rev. 1.0 13 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
Table 5 Other Documents and References
Title Description
Schematics
Module Firmware and
Programming Utilities
Software Utilities
GS Based Module Evaluation Board schematics
supporting:
GS2200M
• IP-to-WiFi (IP2WiFi) based firmware
• Firmware Release Notes
• GSFlashprogram utility for programming the
modules
Serial terminal program to evaluate and demonstrate
IP-to-WiFi (IP2WiFi) applications such as
– gs2k_flashprogram.exe
1VV0301501 Rev. 1.0 14 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
Contact Information, Support
For general contact, technical support services, technical questions and to report
documentation errors contact Telit Technical Support at:
TS-SRD@telit.com
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.
1VV0301501 Rev. 1.0 15 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
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.
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.
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.
CAUTION! Do not stack any of the components.
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:
1VV0301501 Rev. 1.0 16 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
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.
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.
1VV0301501 Rev. 1.0 17 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
1VV0301501 Rev. 1.0 18 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
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)
1VV0301501 Rev. 1.0 19 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
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.
NOTE: For desired functionality use appropriate AT Commands. Refer “GS2K
S2W Reference Use Case User Guide”
– 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: Refer to “GS2K S2W Reference Use Case User Guide” document for
detailed use cases and examples.
1VV0301501 Rev. 1.0 20 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
1.2 Using SDK Builder
1.2.1 IP-to-WiFi Module Information
Selecting the IP-to-WiFi (Hosted) under the SDK Builder Configuration screen displays
the module information that includes the module selected, firmware version, application,
SRAM (APP/WLAN/RTC), and Flash (Internal/External) summary information. There
are several tabs that allow you to select various features and options to build and configure
the IP-to-WiFi (Hosted) application.
1VV0301501 Rev. 1.0 21 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
NOTE: When building Firmware Binary for EVK or AEK Package, it is
recommended that you use the Default Evaluation Build. Otherwise, you can build
Custom, SDK, or ADK Packages for your environment.
The tabular selections to build your IP-to-WiFi (Hosted) application and firmware are as
follows
• Host Interface
• Host Settings
• 802.11 WLAN
• 802 WLRPAN
• ZigBee IP Modes
• Networking Services
• Energy Measurement
• Clock/Power Setting
• Memory Setting
Once you have completed selecting the options and features for building the IP-to-WiFi
(Hosted) firmware, click the Next button or select the Summary tab. The Build
Configuration Summary screen displays a summary of the selected configuration options
(e.g., Module Configuration, Host Interface, Host Settings, 802.11 WLAN, etc.).
1VV0301501 Rev. 1.0 22 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
Chapter 2 Architecture
This chapter describes the overview and architecture of IP-to-WiFi Application.
• Overview, page 23
• Serial Interface, page 24
• System Initialization, page 24
• Command Processing Mode, page 26
• Data Handling, page 27
• Serial Data Handling, page 29
• Wireless Network Management, page 30
2.1 Overview
Figure 2, page 27 shows the overall architecture of the IP-to-WiFi (IP2WiFi) interface.
Transmit (Tx) and Receive (Rx) Data Handlers pass messages to and from the WiFi
interface. Commands related to management of the IP2WiFi interface and the network
connections are intercepted by a Command Processor. A Serial Data Handler translates data
to and from a serial interface (UART/SPI/SDIO).
Figure 1 Operation Modes of the IP-to-WiFi Application
The
IP-to-WiFi Application consists of the following modules:
• Serial Interface, page 24
1VV0301501 Rev. 1.0 23 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
• System Initialization, page 24
• Command Processing Mode, page 26
• Data Handling, page 27
• Serial Data Handling, page 29
• Wireless Network Management, page 30
The software for the IP-to-WiFi Application is mainly driven using a state machine. Upon
powering on, the required initialization of all the modules is performed and then the state
machine is entered. This state machine is event-driven and processes the events received
from either the serial port or from the WiFi/Network interface as well as internal events
from its own modules. The state machine calls the appropriate handler for a given event per
the current state.
The IP-to-WiFi Application has three distinct operating modes (Figure 2, page 25). In the
default command processing operating mode, commands to configure and manage the
interface are sent over the serial interface. In the default mode, the node accepts commands
entered by the Host CPU and processes each of the commands. All commands are available
in this mode. The User can establish a data connection here and send data.
In data processing mode, data can be sent to, or received from the host.
For each mode, configuration parameters are stored in non-volatile memory. In addition to
factory-default parameter values, two user-defined profiles (0 and 1) are available. The
parameter set to be used is determined by a user command (see 4.3.4 Select Default Profile,
page 70).
2.2 Serial Interface
The serial interface used is determined by the interface configuration option selected when
building the binary using SDK Builder.
GS nodes do not support dynamic detection of serial interfaces as SPI or UART binaries
are built from the SDK builder.
2.3 System Initialization
Upon startup, the IP-to-WiFi (IP2WiFi) interface performs the following actions:
– During the initialization process, the module will search for a saved configuration
file. The configuration file include the auto connection settings, default profile
and profile settings. If a saved configuration file is available, it is loaded from
non-volatile memory. If no saved configuration file, the default settings will be
applied. If there are no saved parameters, the factory-default configuration is
loaded.
– The IP2WiFi application is initialized based on the profile settings.
1VV0301501 Rev. 1.0 24 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
– Interface enters the command processing state.
Figure 2 Operating Modes of the IP-to-WiFi Application
IP-to-WiFi binary uses the interface and configuration as per the binary configuration
options selected in SDK Builder. The evaluation binary packages use the following
defaults:
• For UART: 115200 baud using 8 bit characters with no parity bits, one stop bit, and no
• For SPI: SPI Mode 0 (CPL=0, CPH=0)
Any changes to this configuration that were made in a previous session using the ATB
command (see 3.2.1.1 UART Parameters, page 35) will be lost when power is lost. To
make changes in the UART/SPI parameters that will persist across power cycling, the
relevant changes must be saved into the power-on profile using AT&W (see 4.3.2 Save
Profile, page 68) and AT&Y (see 4.3.4 Select Default Profile, page 70).
2.3.1 Profile Definition
The configuration parameter values that define the behavior of the GS node are grouped
into Profiles. These profiles are stored in non-volatile memory when not in use. The GS
node supports two Profiles by default.
flow control
1VV0301501 Rev. 1.0 25 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
2.4 Command Processing Mode
In Command mode, the application receives commands over the serial port. Commands
are processed line by line.
Verbose Mode is used when referring to commands being executed, refers to the displaying
of status of any command executed in ASCII (human readable) format. When the Verbose
Mode is disabled, the output will simply be in numeric digits, each digit indicating a
particular status. Verbose Mode is enabled by default.
If echo is enabled then each character is echoed back on the serial port.
Each command is terminated with a carriage return <CR> or line feed <LF>.
Each response is started with a carriage return <CR> and line feed<LF>, with the
exception of the responses to the following commands:
The response to the following group of commands starts with a line feed <LF> only:
AT+WPAPSK=<SSID>,<Passphrase>
ATA
Unless otherwise specified, if Verbose Mode is enabled, then the response to a successful
command is the characters OK. The response to an unsuccessful command is the word
ERROR, followed by a detailed error message, if available. If verbose mode is disabled,
command responses is numerical with OK having a value of 0 and error codes represented
by positive integers.
1VV0301501 Rev. 1.0 26 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
The default Time Out till S2W Application buffers the data from HOST is 100milliseconds
which can be configured using ATS Command, refer 4.3.7 Identification Information,
page 73.
2.5 Data Handling
In Data Processing Mode, data transfers are managed using various escape sequences.
Each escape sequence starts with the ASCII character 27 (0x1B); this is equivalent to the
ESC key. The encoding of data and related commands are described in the following pages.
This encoding is used for both transmitted and received data.
<ESC>R:<Length>:<Ethernet package>
Where the Ethernet Packet is:
<DstAddr><SrcAddr><EtherType><Payload>
The contents of < > are byte or byte stream.
Table 6, page 27 describes the Encoding of Data parameters.
Table 6 Encoding of Data Parameters
Parameter Description
Length The size of the Ethernet packet.
DstAddr The destination MAC address.
SrcAddr The source MAC address.
EtherType
Payload The raw data.
The type of the Ethernet packet. For example,
BACNET-over-Ethernet, EtherType is 0x0000.
1VV0301501 Rev. 1.0 27 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
2.5.1 Unsolicited/Unassociated/Beacon Mode Data Handling
In Unsolicited Data Mode (data transmission without association), data transfer is
managed using escape sequences. Each escape sequence starts with the ASCII character 27
(0x1B), equivalent to the Escape <ESC> key. For more details, see
5.2.1 Unassociated/Unsolicited Tx, page 93)
2.5.2 Software Flow Control
The Software Flow Control (for UART interface) works only with ASCII data transfers
and cannot be used for binary data. For SPI interface and use of flow control (see 3.2.2 SPI
Interface and Configuration, page 39)
If software flow control is enabled, and the interface receives an XOFF character from the
serial host, it stops sending to the host until it receives an XON character. If the GS node is
receiving data over the wireless connection and the host/mcu sends XOFF character to the
GS node to indicate its inability to process the incoming data over UART Interface, then
there is a possibility for the receiving wireless buffers to be full on the GS node side and
the GS node might drop the data.
If software flow control is enabled, then the interface sends an XOFF character to the host
when it will be unable to service the serial port. The XON character is sent when the
interface is once again able to accept data over the serial port.
NOTE: With initialization, the GS node treats the serial channel as clear with no
restrictions on data transmission or reception; no explicit XON by the GS node or
required from the Host, even if flow control is enabled.
2.5.3 Hardware Flow Control
The Hardware Flow Control is a handshake mechanism between the Serial host and
IP2WiFi Application on UART interface, using two additional CTS and RTS connections.
This feature prevents the UART hardware FIFO overflow on IP2WiFi Application due to
high speed data transmission from/to the IP2WiFi Application. If hardware flow control is
enabled, an RTS/CTS handshake will occur between the serial host and the GS node. This
is a hardware feature and available only for UART interface.
The IP2WiFi Application uses both CTS and RTS signals as “low” to indicate the readiness
to send or receive data from serial host.
1VV0301501 Rev. 1.0 28 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
2.6 Serial Data Handling
The Serial Data Handler receives and transmits data to and from the hardware serial
controller. Data read from the serial port is passed to:
– The command processor in command mode
– The Tx data handler in data mode
– The auto connection mode processor for data transfer in auto connection mode
Then Data is transferred on the serial port from:
– The command processor in order to output responses to commands
– The Tx data handler in order to output incoming packets
– The Rx data handler in order to output incoming packets
– The auto connection handler in order to output incoming data
– The connection manager in order to output status indications
– The wireless connection manager in order to output status indications
1VV0301501 Rev. 1.0 29 2018-03-12
GS2200M IP2WiFi Adapter Command Reference Guide
2.7 Wireless Network Management
2.7.1 Scanning
The IP-to-WiFi interface can instruct the WiFi radio to scan for access points with a
specified SSID, BSSID and/or channel for a specified scan time. Scanning can be
performed to find networks with a specific SSID or BSSID, networks operating on a
specific radio channel or a combination of these constraints.
2.7.2 Association
The IP-to-WiFi interface performs all the actions required to join an infrastructure IP
network:
– Scan for a specific AP (AT+WS) – see 5.3.4 Scanning, page 115
– Authenticate the specified network using the configured authentication mode
(AT+WAUTH) – see 5.3.8 Advanced Commands, page 122 for more information
– Associate to the AP (AT+WA) – see 5.3.5 Association, page 117
– Perform security negotiation if required
– Change state to Wireless Connected
2.7.3 SSID and Passphrase
The following rules apply:
1. The IP2WiFi Application accepts the following ASCII characters for SSID and
passphrase (see Table 7, page 30).
Category Accepted Characters
Numerical 0-9
Alphabets a-z and A-Z
Special Characters
Note: 1. SP = space.
2. The SSID or Passphrase parameter may be captured within or without double
quotation marks (“SSID”).
Table 7 SSID and Passphrase Characters
1
SP ! # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~ ”
3. The quotation mark (“) may not be used as the first character of the SSID or
passphrase.
4. If comma (,) is a part of the SSID, then SSID parameter needs to be framed with
double quotation marks (“SS,ID”) (see Table 8, page 31).
1VV0301501 Rev. 1.0 30 2018-03-12
Loading...