Sierra Wireless AirPrime XS1110 Command Reference Manual
  1. Manuals
  2. Brands
  3. Sierra Wireless Manuals
  4. Control Unit
  5. AirPrime XS1110
  6. Command reference manual

Sierra Wireless AirPrime XS1110 Command Reference Manual

Hide thumbs Also See for AirPrime XS1110:
Table of Contents

Advertisement

Quick Links

Download this manual
AirPrime XS1110
AT Command Reference Guide
41113737
Rev 3.1

Advertisement

Table of Contents
loading

Related Manuals for Sierra Wireless AirPrime XS1110

Summary of Contents for Sierra Wireless AirPrime XS1110

  • Page 1 AirPrime XS1110 AT Command Reference Guide 41113737 Rev 3.1...
  • Page 2 Although significant delays or losses of data are rare when wireless devices such as the Sierra Wireless product are used in a normal manner with a well-constructed network, the Sierra Wireless product should not be used in...
  • Page 3 Preface Patents This product may contain technology developed by or for Sierra Wireless Inc. This product is manufactured or sold by Sierra Wireless Inc. or its affiliates under one or more patents licensed from MMP Portfolio Licensing. Copyright © 2020 Sierra Wireless. All rights reserved.
  • Page 4 XS1110 AT Command Reference Guide Revision Release date Changes number • June 2020 Updated AT+GNSSLOWP • Changed note • Changed Write AT command • Updated <period> parameter under AT+GNSSSLP • Updated <mode> parameter under AT+GNSSUMODE • Updated Table 2-3 Table 2-4 •...

  • Page 5: Table Of Contents

    Contents About This Guide ............7 Introduction .
  • Page 6 AirPrime XS1110 AT Command Reference Customized NMEA Sentences ..........45 Introduction .

  • Page 7: About This Guide

    1: About This Guide Introduction This document describes proprietary AT commands available for Sierra Wireless’ ® AirPrime XS1110 modules. These commands are intended for use by OEMs. Note: For questions or concerns relating to command implementation, please contact your Sierra Wireless account representative.

  • Page 8: References

    AirPrime XS1110 AT Command Reference References For additional product-specific documentation, refer to source.sierrawireless.com. Abbreviations and Terms Used This document makes use of abbreviations and terms that are in common use in data communications and GNSS technology. For details, see Acronyms and Definitions...
  • Page 9 About This Guide Other Commands — Advanced functions Table 1-2: Other Commands (Summary) Command Description Page AT+GNSSTHRES Configure and query the GNSS threshold AT+GNSSRAW Acquire specific data from the GNSS receiver AT+GNSSEPE Configure and query the horizontal and vertical estimated position error (EPE) based on HDOP and VDOP AT+GNSSVELWARN Configure and query GNSS speed warning feature...
  • Page 10 AirPrime XS1110 AT Command Reference Custom NMEA Sentences — Normal output sentences developed by Sierra Wireless Table 1-5: Other Commands (Summary) Command Description Page $PSWIGEOFEN $PSWIGEOFEN Details $PSWIRAW $PSWIRAW Details $PSWIVELW $PSWIVELW Details $PSWIEPE $PSWIEPE Details Rev 3.1 Jul.20 41113737...

  • Page 11: General Commands

    2: General Commands Introduction This chapter describes general AT commands. Command summary The following table lists the commands described in this chapter. Table 2-1: General Commands (Summary) Command Description Page AT+GNSSSTOP Stop positioning and enter standby states AT+GNSSSTART Execute GNSS startup process AT+GNSSSATE Configure and query GNSS search mode AT+GNSSLOWP...
  • Page 12 AirPrime XS1110 AT Command Reference Command reference Table 2-2: General Commands (Detail) Command Description AT+GNSSSTOP Stop positioning and enter standby states Usage: • Execute: AT+GNSSSTOP Response: +GNSSSTOP,OK +GNSSSTOP,<error code> Purpose: Configure module into standby mode. Examples: • Stop positioning: AT+GNSSSTOP<CR><LF>...
  • Page 13 General Commands Table 2-2: General Commands (Detail) (Continued) Command Description AT+GNSSSATE Configure and query GNSS search mode Note: Confirm which search modes are supported by your firmware. Usage: • Write: AT+GNSSSATE=<GP>,<GL>,<GA>,<Reserved>,<BD>,<QZ>,<SBAS> Response: +GNSSSATE,<GP>,<GL>,<GA>,<Reserved>,<BD>,<QZ>,<SBAS>,OK +GNSSSATE,<error code> Purpose: Configure module to use specified satellite. •...
  • Page 14 AirPrime XS1110 AT Command Reference Table 2-2: General Commands (Detail) (Continued) Command Description AT+GNSSLOWP Configure and acquire GNSS low power tracking Note: When low power tracking is enabled, the +GNSSLOWP,ENTRY,OK*5D message appears after the system sleeps. The +GNSSLOWP,WAKEUP,OK*14 message appears after the system wakes up.
  • Page 15 General Commands Table 2-2: General Commands (Detail) (Continued) Command Description AT+GNSSSLP Transfer receiver into sleep states Note: When sleep 0 mode is enabled, wake up will get the +GNSSSLP,WAKEUP,OK*5F message. Usage: • Write: AT+GNSSSLP=<mode>,<period> Response: +GNSSSLP,<mode>,<period>,OK +GNSSSLP,<error code> Purpose: Configure module into sleep mode with specified period. Parameters: <mode>...
  • Page 16 AirPrime XS1110 AT Command Reference Table 2-2: General Commands (Detail) (Continued) Command Description AT+GNSSUMODE Configure and query navigation algorithm to fit different scenarios Usage: • Write: AT+GNSSUMODE=<mode> Response: +GNSSUMODE,<mode>,OK +GNSSUMODE,<error code> Purpose: Set the specific navigation mode. • Read: AT+GNSSUMODE? Response: +GNSSUMODE,<mode>,OK...
  • Page 17 General Commands Table 2-2: General Commands (Detail) (Continued) Command Description AT+GNSSUTC Acquire current UTC Time Note: You must receive the full ephemeris before you can get the valid data. Usage: • AT+GNSSUTC? Read: Response: +GNSSUTC,<year>,<month>,<day>,<hour>,<min>,<sec>.<usec>,OK +GNSSUTC,<error code> Purpose: Get UTC time from module. Parameters: <year>...
  • Page 18 AirPrime XS1110 AT Command Reference Table 2-2: General Commands (Detail) (Continued) Command Description AT+GNSSUTCCOR Acquire the UTC time correction information Note: You must receive the full ephemeris before you can get the valid data. Usage: • AT+GNSSUTCCOR? Read: Response: +GNSSUTCCOR,<Valid>,<A0>,<A1>,<dtLS>,<Tot>,<WNt>, <WNlsf>,<Dn>,<DTlsf>,OK...
  • Page 19 General Commands Table 2-2: General Commands (Detail) (Continued) Command Description AT+GNSSGPST Acquire current GPS Time Usage: • Read: AT+GNSSGPST? Response: +GNSSGPST,<date>,<time>,OK +GNSSGPST,<error code> Purpose: Get GPS time from module. Parameters: <date> (GPS Date) • Format: "yyyymmdd" (YearMonthDay) <time> (GPS Time) •...
  • Page 20 AirPrime XS1110 AT Command Reference Table 2-2: General Commands (Detail) (Continued) Command Description AT+GNSSPOS Set position information into receiver Usage: • Write: AT+GNSSPOS=<lat>,<lon>,<alt> Response: +GNSSPOS,<lat>,<lon>,<alt>,OK +GNSSPOS,<error code> Purpose: Configure the position data into the module. • Read: AT+GNSSPOS? Response: +GNSSPOS,<lat>,<lon>,<alt>,OK +GNSSPOS,<error code>...
  • Page 21 General Commands Table 2-2: General Commands (Detail) (Continued) Command Description AT+GNSSNMEA Configure and acquire general NMEA sentence output types. Usage: • Write (<action> = 3): AT+GNSSNMEA=<action>,<NMEA_type>,<state> Response: +GNSSNMEA,<action>,<NMEA_type>,<state>,OK +GNSSNMEA,<error code> Purpose: Configure specified NMEA type output or not. • Write (<action> = 2): AT+GNSSNMEA=<action>,<NMEA_type>...
  • Page 22 AirPrime XS1110 AT Command Reference Table 2-2: General Commands (Detail) (Continued) Command Description <GSA> (GNSS DOP and active satellites) • 0—Disable • 1—Enable (Default) <GSV> (GNSS satellites in view) • 0—Disable • 1—Enable (Default) <GNS> (GNSS fix data) • 0—Disable (Default) •...
  • Page 23 General Commands Table 2-2: General Commands (Detail) (Continued) Command Description AT+GNSSGEOFEN Configure and acquire geo-fencing settings Usage: • Write (<action> = 0,1): AT+GNSSGEOFEN=<action> Response: +GNSSOFEN,<action>,OK +GNSSOFEN,<error code> Purpose: After setting enable / disable, $PSWIGEOFEN sentence will be set or not set as an output.
  • Page 24 AirPrime XS1110 AT Command Reference Table 2-2: General Commands (Detail) (Continued) Command Description <sentence_status> (Show the $PSWIGEOFEN sentence is enabled or disabled) • 0—Disable • 1—Enable <region_data> (The data of each specified region) • Formats: <id>,<latitude>,<longitude>,<radius>,<status> • <status>: The status that shows the module is in the specified region or not •...
  • Page 25 General Commands Table 2-2: General Commands (Detail) (Continued) Command Description AT+GNSSPPS Configure and query output time in one pulse per second (1PPS) function Usage: • Write: (<mode> = 0) AT+GNSSPPS=<mode> Response: +GNSSPPS,0,OK +GNSSPPS,<error code> Purpose: Disable 1 PPS output. • Write: (<mode>...
  • Page 26 AirPrime XS1110 AT Command Reference Table 2-3: Sleep States Sleep Main RAM Backup RAM Module activity upon waking up State status status Sleep 0 Retained Retained Re-start with previous setting (hot start). Sleep 1 Retained Reboot a. The main RAM contains the firmware (GNSS kernel firmware and GNSS systems) and all data during GNSS reception.
  • Page 27 Sleep 1 State Note: Sleep 1 has a lower consumption than Sleep 0 but the TTFF time for Sleep 1 is slower. For details, see the AirPrime XS1110 Product Technical Specification. Table 2-4: Satellite System Settings The following table indicates which satellite systems are supported by the GNSS kernel.

  • Page 28: Normal Mode

    AirPrime XS1110 AT Command Reference Normal Mode In Normal mode, the XS1110 module keeps on operating normally and updates the latest navigation message anytime to get an accurate positional information. Figure 2-1: Power Consumption in Normal Mode Low Power Tracking...
  • Page 29 General Commands Figure 2-3: Low Power Tracking Behavior Figure 2-4: 1PPS Output Types Rev 3.1 Jul.20 41113737...

  • Page 30: Other Commands

    3: Other Commands Introduction This chapter describes other types of AT commands. Command summary The following table lists the commands described in this chapter. Table 3-1: Other Commands (Summary) Command Description Page AT+GNSSTHRES Configure and query the GNSS threshold AT+GNSSRAW Acquire specific data from the GNSS receiver AT+GNSSEPE Configure and query the horizontal and vertical...
  • Page 31 Other Commands Command reference Table 3-2: Other Commands (Detail) Command Description Configure and query the GNSS threshold AT+GNSSTHRES Usage: • Write (<action> = 2): AT+GNSSTHRES=<action>,<ID> Response: +GNSSTHRES,< action >,<ID>,OK +GNSSTHRES,<error code> Purpose: Set the default threshold value for positioning. • Write (<action>...
  • Page 32 AirPrime XS1110 AT Command Reference Table 3-2: Other Commands (Detail) (Continued) Command Description <horizontal> (The maximum value of horizontal accuracy) (unit: meter) • 0—Default • Valid value: 0-300 <HDOP> (The maximum value of horizontal dilution of precision) (no unit) •...
  • Page 33 Other Commands Table 3-2: Other Commands (Detail) (Continued) Command Description AT+GNSSEPE Configure and query the horizontal and vertical estimated position error (EPE) based on HDOP and VDOP Usage: • Write: AT+GNSSEPE=<status> Response: +GNSSEPE,<status>,OK +GNSSEPE,<error code> Purpose: Configure the output mode for $PSWIEPE. •...
  • Page 34 AirPrime XS1110 AT Command Reference Table 3-2: Other Commands (Detail) (Continued) Command Description AT+GNSSVELWARN Configure and query GNSS speed warning feature Usage: • Write (<action> = 0, 1): AT+GNSSVELWARN=<action> Response: +GNSSVELWARN,<action>,OK +GNSSVELWARN,<error code> Purpose: After enabling or disabling, the $PSWIVELW sentence becomes set to output or not.
  • Page 35 Other Commands Table 3-2: Other Commands (Detail) (Continued) Command Description AT+GNSSPVTL Configure and query the log and configuration of PVT log in flash Steps: Enable PVT log function. Disable PVT log function. Get PVT log function. Usage: • Write (<action> = 0, 1, 2): AT+GNSSPVTL=<action>...
  • Page 36 AirPrime XS1110 AT Command Reference Table 3-2: Other Commands (Detail) (Continued) Command Description Parameters: <action> (PVT log mode) • 0—Disable (Default) • 1—Enable • 2—Erase • 3—Set recording mode <override_mode> (PVT log override mode) • 0—Stop recording data (Default) •...

  • Page 37: Agnss Commands

    4: AGNSS Commands Introduction This chapter describes AGNSS related AT commands. Command Summary The following table lists the commands described in this chapter. Table 4-1: AGNSS Commands (Summary) Command Description Page AT+GNSSLLE Configure connecting AGNSS function and acquire the status AT+GNSSSGE Enable / disable autonomous AGNSS function and acquire the status...

  • Page 38: Command References

    AirPrime XS1110 AT Command Reference Command References Table 4-2: AGNSS Commands (Detail) Command Description Configure connecting AGNSS function and acquire the status AT+GNSSLLE Usage: • Write (<action> = 0, 1, 2): AT+GNSSLLE=<action> Response: +GNSSLLE,<action>,OK +GNSSLLE,<error code> Purpose: Set the LLE function to enabling, disabling, or erasing.
  • Page 39 AGNSS Commands Table 4-2: AGNSS Commands (Detail) (Continued) Command Description Parameters: <action> • 0—Disable LLE function. • 1—Enable LLE function. • 2—Erase LLE data in flash. • 3—Set LLE data saved into flash. • 4—Check the integrity of the injected LLE data in flash. <packet_num>...
  • Page 40 AirPrime XS1110 AT Command Reference Table 4-2: AGNSS Commands (Detail) (Continued) Command Description AT+GNSSSGE Enable / disable autonomous AGNSS function and acquire the status Usage: • Write: AT+GNSSSGE=<action> Response: +GNSSSGE,<action>,OK +GNSSSGE,<error code> Purpose: Configure SGE function. • Read: AT+GNSSSGE? Response: +GNSSSGE,<action>,<satellite A>,<satellite B>,OK...

  • Page 41: System Commands

    5: System Commands Introduction This chapter describes system AT commands. Command summary The following table lists the commands described in this chapter. Table 5-1: System Commands (Summary) Command Description Page AT+GNSSFER Erase the currently saved firmware AT+GNSSFSN Acquire the serial number of the GNSS module AT+GNSSVERS Acquire the SWIR-defined firmware version AT+GNSSRTC...

  • Page 42: Command Reference

    AirPrime XS1110 AT Command Reference Command reference Table 5-2: System Commands (Detail) Command Description Erase the currently saved firmware AT+GNSSFER Usage: • Exec: AT+GNSSFER Response: +GNSSFER,OK +GNSSFER,<error code> Example: • Erase the current firmware: AT+GNSSFER<CR><LF> +GNSSFER,OK*59<CR><LF> Acquire the serial number of the GNSS module...
  • Page 43 System Commands Table 5-2: System Commands (Detail) (Continued) Command Description AT+GNSSRTC Get CPU time and the elapsed time since system startup Usage: • Read: AT+GNSSRTC? Response: +GNSSRTC,<rtc_time>,OK +GNSSRTC,<error code> Parameters: <rtc_time> (RTC Time) • Unit: microsecond • Format: hex Example: •...
  • Page 44 AirPrime XS1110 AT Command Reference Table 5-2: System Commands (Detail) (Continued) Command Description AT+GNSSTCXO Acquire TCXO offset value Usage: • Read: AT+GNSSTCXO? Response: +GNSSTCXO,<TCXO>,OK +GNSSTCXO,<error code> Purpose: Get TCXO offset. Parameters: <TCXO> (TCXO offset) • Unit is in Hz. Example: •...

  • Page 45: Customized Nmea Sentences

    6: Customized NMEA Sentences Introduction This chapter describes the normal output sentences developed by Sierra Wireless. These sentences will output with NMEA when the user enables it by command. Command summary The following table lists the commands described in this chapter.

  • Page 46: Command Reference

    AirPrime XS1110 AT Command Reference Command reference $PSWIGEOFEN Details A geo-fence is a virtual perimeter for a real-world geographic area. It could be dynamically generated, as in a radius around a point location, or a predefined set of boundaries, such as school zones or neighborhood boundaries.

  • Page 47: Pswivelw Details

    Customized NMEA Sentences $PSWIVELW Details Speed warn allows users to set the maximum velocity that will be seen as safe. If the speed is over this value, speed warn will be activated. The following table explains the $PSWIVELW sentence format: $PSWIVELW,20190905,055601.00,1*27 Table 6-3: $PSWIVELW Data Format Name...

  • Page 48: Pswiraw Details

    AirPrime XS1110 AT Command Reference $PSWIRAW Details Raw measurement brings more information for analysis, for the production line, and for application. The information should output as a NMEA sentence. The output frequency is same as NMEA sentences. The following table explains the $PSWIRAW sentence format: $PSWIRAW,20190904,095849.00,1,015,37.13,21442795.307,695888.540,-...

  • Page 49: Pswiepe Details

    Customized NMEA Sentences $PSWIEPE Details EPE is the horizontal and vertical estimated position error based on HDOP and VDOP. The following table explains the $PSWIEPE sentence format: $PSWIEPE,20190905,060310.00,10.5,7.6,4.6,6.0,7.3*56 Table 6-5: $PSWIEPE Data Format Name Example Units Description Message ID $PSWIEPE $PSWIEPE header UTC Date 20190904...

  • Page 50: Error Codes

    A: Error Codes When communication has failed, the module will show an error code. The following table describes the definition of the error code. Table A-1: Error Codes Error Error Name Description Code GRECO_AT_COMMAND_RESPONSE_EXECUTION_FAIL Function executes with wrong result. GRECO_AT_COMMAND_RESPONSE_NOT_ATCMD Unsupportable command.

  • Page 51: Abbreviations

    B: Abbreviations Table B-1: Acronyms and Definitions Abbreviation Meaning Definition AGNSS Assisted Global Navigation While using a GPS / GNSS receiver in an Satellite System inadequate signaling situation, for example, the module is applied in a building where only a weak signal can be received, it may depend on periodically receiving the orbital information of the target satellite from a calculating source...
  • Page 52 AirPrime XS1110 AT Command Reference Table B-1: Acronyms and Definitions (Continued) Abbreviation Meaning Definition NMEA The National Marine This is a standard data format supported by all Electronics Association GPS manufacturers. The output definition consists of latitude, longitude, time, etc.

  • Page 53: Pvt Log Table

    C: PVT Log Table Table C-1: PVT Log Payload Definition Parameters 0-19 Latitude (decimal places of minutes) 20-25 Latitude (minutes) Latitude 26-32 Latitude (degrees) Latitude symbol 0: Plus (north latitude) 1: Minus (south latitude) 34-53 Longitude (decimal places of minutes) 54-59 Longitude (minutes) Longitude...
  • Page 54 AirPrime XS1110 AT Command Reference Table C-1: PVT Log Payload (Continued) Definition Parameters 142-148 Year 149-153 Date (UTC) 154-157 Month 158-159 Positioning mode Mode 0: Not fixed 1: Fixed 2: Assisted GPS 3: Dead Recording Rev 3.1 Jul.20 41113737...

This manual is also suitable for:

Airprime xp2210

Table of Contents