Location Library 1.3 Release note

    Last Update: March 7th, 2012

1. NEW FEATURES.
2. SOFTWARE RELEASE DESCRIPTION.
   2.1 Software Identification.
   2.2 Deliverables.
   2.3 Compatibility.
   2.4 Software Installation.
3. KNOWN RESTRICTIONS.
4. INTERFACE MODIFICATIONS.
   4.1 Library APIs.
   4.2 GPS AT Commands.
5. CORRECTIONS & IMPROVEMENTS.
6. MEMORY REQUIREMENTS.

1. New Features.

The Location Library1.3 is an update release of Location Library 1.2 that does include following new features compared to Location library 1.2 release:

• Solution Accuracy New ‘$PSWI-SA’ NMEA sentence providing indicator about quality of fix
• XM0110 Deep sleep mode: Ability to decrease XM0110 power consumption below 10µA.
• Assisted GPS: Server based Extended Ephemeris from SiRF server.
• Time To First Fix improvement: faster TTFF now returning 2D fix in addition to 3D fix.
• GPS Tracking: now configurable at a lower rate than 1 Hertz, decreasing global power consumption of the system.
• Jamming detection and removal: Notify application of GPS Jammers presence and filter it.
• Software blanking: Limit wide band noise link to GSM/GPRS impact in case of antennas proximity.

2. Software Release Description.

2.1 Software Identification.

Software Identification
Location Library Package	1.3.0.201202061130
Version string reported by the Library Library API	GPS-LocLib.1.3.0-Feb  6 2012-11:24:31-SiRFHostIV-4.1.2-B9c1a GSD4t_4.1.2-B9 02/02/2012 033
Version string reported by the +GPSVERS? AT command	GPSAT.1.3.0 -GPS-LocLib.1.3.0-Feb  6 2012-11:24:31-SiRFHostIV-4.1.2-B9c1a GSD4t_4.1.2-B9 02/02/2012 033

2.2 Deliverables.

This Location Library release includes

• The Location 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 Library Development Guide” for API description and porting guidelines..
• The GPS_AT_cmd sample application: an application offering AT commands on top of Location 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.
• The SimpleSample sample application: This application is available in source code, starts the Location service and output the GPS position data to the user through AT responses. It is designed for use with XM0110 Development Kit Daughter Board with UART configuration and does not require entering any application specific AT commands.

2.3 Compatibility.

Air Prime™ Intelligent Embedded Module compatibility list

WMP1x0* / Q2686G/87G** / SL6087

* 16Mb RAM or larger is required. 32/8Mb memory combo not supported, 32/16Mb memory combo supported but requires changing default memory mapping.

** Q2686H and Q2687H are not supported due to memory limitation.

 

GPS hardware compatibility list

XM0110 (XM0110 Daughter Board for Development Kit, or XM0110 based application)

 

OS / Firmware / Libraries compatibility
Open AT Framework 2.37 or later Firmware 7.47 or later OS 6.37 or later WIP 5.43 or later IMPORTANT: not compatible with Open AT Framework 2.34, Open AT Framework 2.35 / not compatible with Firmware 7.44 and 7.45

 

Tools compatibility list

Developer Studio: 1.2.0 or later Tool chains: ARM_EABI_GCC and RVDS (ARM_ELF_GCC not supported)

2.4 Software Installation.

To use the GPS AT commands, you can download the Extended AT Command Application binary on top of your Embedded Module Firmware. The .dwl application file is available from latest Open AT Framework SDK 2.37 (see Download tab on Location Library product page:

http://www.sierrawireless.com/productsandservices/AirPrime/Application_Framework/Libraries/Location.aspx ).

You can also refer to the AirPrime XM0110 Development Kit Daughter Board User Guide or to Sierra Wireless Discovery Tool GPS page to assist you in your first steps.

To integrate the Location Library for Open AT® to your own application, you must install the Open AT Framework SDK and include the “Location Library” in the Libraries tabs of your project properties. You can also create a new Open AT project based on the Location Library samples available in the SDK: the GPS Simple sample or the GPS_AT_cmd sample.

 

NOTE: Depending on your system memory, you may encounter Memory Allocation Error while loading the application binary on your Embedded Module. Please review Memory requirements section for more details.

3. Known restrictions.

The known restrictions of this release are:

Id	Description (What / When)	Impacted Domain	Impacted Sub Domain	Detected in …
61415	The first start is failed from Sleep state / IDLE mode when GPS position is not fixed within 10 sec, before going to Sleep state / IDLE mode.	GPS AT cmd. Location Lib.		1.2.0
61503	Stop transition could be blocked if transition is triggered on GPS_START_EVENT event. Therefore GPS_ERR_STATE_TRANSITION error (-5) is always returned.	GPS AT cmd. Location Lib.		1.2.0
62602	Location start error related to GPS firmware download failure can occur with I2C bus.	GPS AT cmd. Location Lib.	I2C	1.3.0
62737	GPSEVAID: 0,2 is not available	GPS AT cmd. Location Lib.	A-GPS	1.3.0

4. Interface modifications.

4.1 Library APIs.

The Location Library interface modifications 1.2.0.201108191103 release are:

Backward Compatible	Change	Comments
Yes	gps_pvtFixState_e GPS_FIX_1SV_DEGRADED, GPS_FIX_2SV_DEGRADED enum values added
Yes	gps_coreOpt_e GPS_OPT_CORE_INFO_HANDLER, GPS_OPT_CORE_INFO_DATA, GPS_OPT_CORE_INFO_RATE, GPS_OPT_CORE_NAV_RATE_FACTOR, GPS_OPT_CORE_BLANKING enum values added
Yes	gps_coreDebugData_e GPS_CORE_DEBUG_INFO, GPS_CORE_DEBUG_TRACE, GPS_CORE_DEBUG_MAX enum values added
Yes	gps_coreLnaConfig_e GPS_LNA_INTERNAL_WITH_GPIO_LNA_EN_ALWAYS_OFF, GPS_LNA_EXTERNAL_WITH_GPIO_LNA_EN_ALWAYS_OFF enum values added
Yes	gps_coreDebugEvent_e GPS_CORE_DEBUG_INFO_EVT, GPS_CORE_DEBUG_TRACE_EVT enum values added
Yes	Add gps_coreInfoEvent_e, gps_coreInfoData_e, gps_coreInfoJam_t, gps_coreBlanking_e enum for Core information management
Yes	Add new callback definition gps_coreInfoHandler_f for Core Information management
Yes	gps_pvtPosition_t validStatus field added
Yes	gps_sleepMode_e GPS_DEEP_MODE enum value added
Yes	gps_infoOpt_e GPS_OPT_INFO_2D_TTFF, GPS_OPT_INFO_3D_TTFF enum values added
Yes	gps_aidingDeeCmd_e GPS_AIDING_DEE_CMD_FORCE enum value added

4.2 GPS AT Commands.

 

The Location AT commands interface modifications since 1.2.0.201108191103 release are:

Backward Compatible	Change	Comments
NO	+GPSVERS command return : Sample version added
YES	New Reduced Rate GPS Navigation parameter and Blanking configuration for +GPSCONF command
YES	New +GPSCORE command for Jammer Information configuration
NO	Value  4 is forbidden in field <output> for +GPSDEBUG Command
YES	Add Debug Core information and Debug Core traces in field <debug data> for +GPSDEBUG Command
YES	+GPSSLEEP=0 can be done only if GPS 3D fix is available
No	+GPSTTFF command returns also the calculated 2D TTFF
Yes	New DEEP SLEEP mode for +GPSSLEEP command
Yes	New DEE forced download command for +GPSAID command




5. Corrections & Improvements.

The following issues have been fixed in this release compared to 1.2.0.2011008191103 release:

 

Id	Issue Description		Impacted Domain
59165		GPS_SLEEP state is not restored after AT+GPSSAVE=1 and +CFUN=1.	Sleep mode
60806		Lost of channel communication between Host and XM0110 in I2C
59669		gps_getState should return GPS_ERR_STATE_TRANSITION (-5) when the transition is in progress
61393		GPSEVABORT: -41 may be produced while SLEEP IDLE.	GPS AT cmd. Location Lib.
		Support SirfHostIV tracker - v4.1.2 (Host and FW libraries – Product candidate release) -  SiRFHostIV-4.1.2-B9c1a B9c1a Host library – Product candidate release -  GSD4t_4.1.2-B9 tracker FW library version – Product candidate release





6. Memory requirements.

The GPS_AT_cmd application binary size is 954kB for RVDS compiler use. The Library memory footprint depends on the tool chain used:

Tool chain		Location Library	Location Library with AT Application
GCC_EABI	ROM	822 kBytes	847 kBytes
	RAM total (with EE)	322 kBytes	334 kBytes
	RAM total (no EE)	259 kBytes	271 kBytes
	Static RAM	236 kBytes	236 kBytes
	Stack size (no EE)	23 kBytes	35 kBytes
	Extra Stack size for AEE	7 kBytes	7 kBytes
	Extra Stack size for DEE	16 kBytes	16 kBytes
	Dynamic RAM (no EE)	0 kBytes	0 kBytes
	Extra dynamic RAM for EE	40 kBytes	40 kBytes
	NV Memory (with EE)	60 kBytes	60 kBytes
	NV Memory (no EE)	20 kBytes	20 kBytes
RVDS	ROM	821 kBytes	847 kBytes
	RAM total (with EE)	321 kBytes	332 kBytes
	RAM total (no EE)	258 kBytes	269 kBytes
	Static RAM	236 kBytes	236 kBytes
	Stack size (no EE)	22 kBytes	33 kBytes
	Extra Stack size for AEE	7 kBytes	7 kBytes
	Extra Stack size for DEE	16 kBytes	16 kBytes
	Dynamic RAM (no EE)	0 kBytes	0 kBytes
	Extra dynamic RAM for EE	40 kBytes	40 kBytes
	NV Memory (with EE)	60 kBytes	60 kBytes
	NV Memory (no EE)	20 kBytes	20 kBytes

IMPORTANT: Due to memory constraints,

• Applications based on Location Library are not compatible with
  • WMP1x0 with 32/8Mb memory combo. 32/16Mb, 64/16Mb, or larger must be used.
• Applications based on Location Library 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 or Simple XM0110 GPS sample, this will be managed automatically.