Location Library 1.0 Release note
- Nov 29, 2010
- Author: Sierra Wireless
- Version: 1
- NEW FEATURES. Last Update: November 29th, 2010
- SOFTWARE RELEASE DESCRIPTION.
2.1 Software Identification.
2.2 Compatibility.
2.3 Software Installation. - KNOWN RESTRICTIONS.
- INTERFACE MODIFICATIONS.
- CORRECTIONS & IMPROVEMENTS.
- MEMORY REQUIREMENTS.
This release is the first official release of the Location Plug-In for Open AT, to be executed on Open AT compatible AirPrime Embedded Modules, and combined with AirPrime XM0110 GPS module.
This Location Plug-In release includes
- The Location Plug-In library for Open AT: an Open AT library, ready to be integrated into customer application thanks to an high level simple and generic GPS API set. See “Location Plug-In Development Guide” for API description and porting guidelines..
- The GPS_AT_cmd sample application: an application offering AT commands on top of Location Plug-In library. This application is available in source code allowing customer to use it as an example, to integrate it in its application, or to enhance it. See “Location AT Commands Interface Guide” for description of the GPS AT commands implemented.
As a complement to Location Plug-In, Sierra Wireless also distributes:
- The Extended AT Command Application: a ready to use application that extends AirPrime Firmware AT command set with additional AT commands, including AT commands for AirPrime XM0110 GPS module. This application is available in binary format for download and execution on AirPrime Embedded Module. This application is based on the GPS_AT_cmd sample application. “Location AT Commands Interface Guide” is the user guide of the GPS AT commands of the Extended AT Command Application.
This Location Plug-In main features of this release are:
- Control of the GPS feature and XM0110 module: init, start, stop, release
- Control of the GPS low power modes: 1Hz low power navigation, GPS idle mode and GPS hibernate mode
- Activation and control NMEA frames output: start, stop, configure output rate, configure list of sentences
- Activation and control of PVT data output (position, velocity, time, GPS state): start, stop, configure output rate
- Ability to change hardware settings if default settings are not applicable to the target hardware, activate external LNA settings, etc.
- GPS raw data debug mode supported
- Autonomous Assisted GPS (Autonomous Extended Ephemeris)
The main functional restrictions of this release compared to documentation are:
- I2C not supported
- No Compatibility to Embedded Module sleep mode (32K mode).
- RVDS and GCC-EABI tool chains not supported
Following features are not available in this release and planed for a future release:
- Low update rate (slower than 1Hz) low power navigation mode (NMEA rate and PVT rate slower than 1Hz are supported, but this will not result in power savings).
- Jamming detection
- Server based Assisted GPS
2. Software Release Description.
| Software Identification | |
|---|---|
| Location Plug-In Package | 1.0.1.201011031042 |
| Location Plug-In library | 1.01.2012 |
| GPS AT commands application binary | GPS_AT_cmd.dwl |
| Version string reported by the Plug-In library API or AT command | GPS-1.01.2012-Oct 29 2010-19:33:17-SiRFHostIV-4.0.2-B16c2a GSD4t_4.0.2 -B16_16x 08/10/2010 222 |
The Extended AT Command Application based on this Location Plug-In release is :
ExtendedATApplication_1.0.0.201011101849.dwl
| Air Prime™ Intelligent Embedded Module compatibility list |
|---|
| WMP1x0* / Q2686G/87G** / SL6087 |
* 16Mb RAM or larger is required. 32/8Mb memory combo not supported.
** Q2686H and Q2687H are not supported due to memory limitation.
| GPS hardware compatibility list |
|---|
| XM0110 based application, connected over UART to AirPrime Embedded Module XM0110 Daughter Board for Development Kit (with UART settings) |
| OS / Firmware / Plug-Ins compatibility |
|---|
| OASiS 2.34 or later |
| Tools compatibility list |
|---|
| Developer Studio 1.1.2 or later GCC tool chain |
To use the GPS AT commands, you can download the Extended AT Command 1.0.0Application binary on top of your Embedded Module Firmware. You can get the .dwl application file from Sierra Wireless website on XM0110 Support and Download page:
http://www.sierrawireless.com/en/sitecore/content/Sierra%20Wireless/Support/Downloads/AirPrime/XM_Series/AirPrime_XM0110.aspx . You can also refer to the AirPrime XM0110 Quick Start Guide document or to Sierra Wireless Discovery Tool GPS page to assist you in your first steps.
To use the Location Plug-In for Open AT® to integrate it into your own application, you must install the software package using Sierra Wireless’ Developer Studio 1.1.2 or later, by adding the Location Plug-In repository URL in the package manager perspective: http://www.wavecom.com/eclipseUpdates/locationpackage . You must then make sure you include the Location Plug-In in the Plug-Ins tabs into your project. You can also create a new Open AT project based on the GPS_AT_cmd sample, available with Location Plug-In package.
The main functional restrictions of this release compared to documentation are
- I2C not supported
- RVDS and GCC-EABI too chains not supported
In addition, following restrictions apply:
| Id | Description (What / When) | Impacted Domain | Impacted Sub Domain | Detected in … |
|---|---|---|---|---|
| 57781 | AT+GPSNMEA=2 generates a WCPU reset due to conflict on UART 2 (used for GPS companion communication). | GPS AT cmd. | HW settings | 1.0.1.Alpha |
| 58773 | Debug UART remains subscribe in Data mode when AT+GPSDEBUG=0,X is entered | GPS AT cmd. | GPS raw data debug | 1.0.1.Beta2 |
| 59281 | The AT+GPSINIT response is not received immediately through the virtual port (CMUX) used to send the AT command until new AT command is sent in the same virtual port. | GPS AT cmd. | CMUX | 1.0.1.Beta2 |
| 59317 | The AEE feature not activated if a first gps_start was previously done with AEE option disabled. Embedded Module reset is then required. | GPS AT cmd. Location Lib. | AEE | 1.0.1.Beta2 |
| 59369 | When start from the state GPS_SLEEP / GPS_HIBERNATE_MODE is failed, any next start will always fail. The Location Plug-In should be stopped in this case before the restart. | GPS AT cmd. Location Lib. | Sleep mode | 1.0.1.Beta2 |
| 59418 | The configuration of the navigation low power mode is not functional in GPS_INITIALIZED and GPS_SLEEP state. This configuration should be applied in the GPS_RUNNING state through the gps_coreSetOpts function or the AT+GPSCONF=0,X command. | GPS AT cmd. Location Lib. | Low power navigation | 1.0.1.Beta2 |
| 59423 | The Satellites in View Signal To Noise Ratio of the PVT service is not consistent when the Very Low/Low/Medium power navigation modes are activated. The field statsInViewSNR of the PVT structure gps_pvtSatInViewInfo_t is not consistent. The fields 8/11/14/17/20 of the PVT sentence number 3 are not consistent. |
GPS AT cmd. Location Lib. | Low power navigation | 1.0.1 |
| 58578 | Location Plug-In is not compatible with Airprime module W32K sleep mode | GPS AT cmd. Location Lib. | Low power navigation | 1.0.1 |
| 58187 | When in GPS_SLEEP state sleep request (AT+GPSSLEEP=X or gps_sleep(GPS_XXX_MODE)) is rejected. It is required to go to GPS_INITIALIZED state to change sleep mode. | GPS AT cmd. Location Lib. | Sleep mode | 1.0.1.Alpha |
| 59165 | GPS_SLEEP state is not restored after AT+GPSSAVE=1 and +CFUN=1. | GPS AT cmd. | Sleep mode | 1.0.1.Beta2 |
The Location Plug-In interface modifications since 1.0.1.Beta201010051505 delivery are:
| Backward Compatible | Change | Comments |
|---|---|---|
| No | GPS_SLEEP_STATE_EVENT renamed as GPS_SLEEP_EVENT. GPS_SLEEP_STATE_ERROR_EVENT renamed as GPS_SLEEP_ERROR_EVENT |
The Location Plug-In interface modifications since 1.0.1.Beta201006211327 delivery are:
| Backward Compatible | Change | Comments |
|---|---|---|
| Yes | Add GPS_ERR_STATE_TRANSITION error code | |
| Yes | Add GPS_ERR_ABORT_INTERNAL, GPS_ERR_ABORT_NMEA and GPS_ERR_ABORT_RESET error code for WD reset management | |
| No | Host wakeup external interrupt ID parameter added in the gps_ioConfigXM0110_t type | |
| No | u16WakeupCmdID renamed as u16GpsRecWakeupCmdID | |
| No | GPS_RESET_EVENT renamed as GPS_ABORT_EVENT | |
| No | gps_setSleepMode() renamed as gps_sleep().GPS_SLEEP_MODE and GPS_DEEP_SLEEP_MODE renamed as GPS_IDLE_MODE and GPS_HIBERNATE_MODE | |
| No | GPS_OPT_CORE_POWER_MODE renamed as GPS_OPT_CORE_RUNNING_POWER_MODE | |
| Yes | Add GPS_OPT_CORE_AIDING_MODE, GPS_OPT_CORE_DEBUG_HANDLER_INPUT and GPS_OPT_CORE_BOOST_MODE_HANDLER enum in gps_coreOpt_e | |
| Yes | The GPS_OPT_CORE_LNA_EXT option type is changed from Boolean to Enumeration. | |
| Yes | gps_getVersion function can be called in the GPS_SLEEP state | |
| Yes | Add GPS_AIDING_NONE and GPS_AIDING_AEE enums in gps_coreAidingMode_e |
For Location Plug-In interface modifications between 1.0.1.Alpha and 1.0.1.Beta201006211327 see previous CRN
The Location AT commands interface modifications since 1.0.1.Beta201010051505 delivery are:
| Backward Compatible | Change | Comments |
|---|---|---|
| Yes | +GPSPVT command added. | |
| Yes | New error code GPS_AT_ERR_SCHED_TASK (-65). |
The Location AT commands interface modifications since 1.0.1.Beta201006211327 delivery are:
| Backward Compatible | Change | Comments |
|---|---|---|
| No | New hardware configuration for +GPSINIT AT command. Factory default values modified to match dev kit v2. | |
| No | Application LED and host wake-up external interrupt ID parameters added in +GPSINIT AT command. | |
| Yes | +GPSVERS AT command now allowed in GPS_SLEEP state | |
| No | The +GPSEVRESET is renamed +GPSEVABORT |
The following issues have been fixed in this release compared to 1.0.1.Beta2 release:
| Id | Issue Description | Impacted Domain |
|---|---|---|
| 59271 | GPS_AT_Cmd application doesn’t work (reset) after update from another GPS_AT_Cmd application release if +GPSSAVE=1 was used with previous application. Flash object must be erased. | Location Plug-In library |
The GPS_AT_cmd application size is 885 kBytes.
The Extended AT command 1.0.0 application size is 1021 kBytes
The Plug-In memory footprint depends on the tool chain used:
| Tool chain | Location Plug-In library | Location Plug-In with AT Application | |
|---|---|---|---|
| GCC | ROM | 736 kBytes | 754 kBytes |
| RAM total (with AEE) | 572 kBytes | 600 kBytes | |
| RAM total (no AEE) | 390 kBytes | 418 kBytes | |
| Static RAM | 294 kBytes | 294 kBytes | |
| Stack size (no AEE) | 96 kBytes | 124 kBytes | |
| Extra Stack size for AEE | 96 kBytes | 96 kBytes | |
| Dynamic RAM (no AEE) | 0 kBytes | 0 kBytes | |
| Extra dynamic RAM for AEE | 86 kBytes | 86 kBytes | |
| NV Memory (with AEE) | 106 kBytes | 106 kBytes | |
| NV Memory (no AEE) | 20 kBytes | 20 kBytes |
IMPORTANT:
- Due to memory constraints,
- Applications based on Location Plug-In are not compatible with:
- Q2686H/Q2687H. Q2686G/Q2687G must be used instead.
- WMP1x0 with 32/8Mb memory combo. 32/16Mb, 64/16Mb, or larger must be used.
- Applications based on Location Plug-In may require to change Embedded Module storage space allocation. To check the current values use AT+WOPEN=6 command. The application size storage must be greater than the application binary size and can be increase by decreasing the A&D storage size with AT+WOPEN=6,XXX command.
- Developer Studio project must be built with 1MB+ memory options. If you are using Developer Studio 1.1.2 or later and create an application based on GPS_AT_cmd sample, this will be managed automatically.
Comment
Forum