blob: 981f6fe9b3ba6f76dc170413ae450cd22333f958 [file] [log] [blame]
page.title=Location-based Service APIs
@jd:body
<p>The Android SDK includes two packages that provide Android's primary support
for building location-based services:
{@link android.location} and com.google.android.maps.
Please read on below for a brief introduction to each package.</p>
<h2>android.location</h2>
<p>This package contains several classes related to
location services in the Android platform. Most importantly, it introduces the
{@link android.location.LocationManager}
service, which provides an API to determine location and bearing if the
underlying device (if it supports the service). The LocationManager
should <strong>not</strong> be
instantiated directly; rather, a handle to it should be retrieved via
{@link android.content.Context#getSystemService(String)
getSystemService(Context.LOCATION_SERVICE)}.</p>
<p>Once your application has a handle to the LocationManager, your application
will be able to do three things:</p>
<ul>
<li>Query for the list of all LocationProviders known to the
LocationManager for its last known location.</li>
<li>Register/unregister for periodic updates of current location from a
LocationProvider (specified either by Criteria or name).</li>
<li>Register/unregister for a given Intent to be fired if the device comes
within a given proximity (specified by radius in meters) of a given
lat/long.</li>
</ul>
<p>However, during initial development, you may not have access to real
data from a real location provider (Network or GPS). So it may be necessary to
spoof some data for your application, with some mock location data.</p>
<p class="note"><strong>Note:</strong> If you've used mock LocationProviders in
previous versions of the SDK (m3/m5), you can no longer provide canned LocationProviders
in the /system/etc/location directory. These directories will be wiped during boot-up.
Please follow the new procedures below.</p>
<h3>Providing Mock Location Data</h3>
<p>When testing your application on the Android emulator, there are a couple different
ways to send it some spoof location data: with the DDMS tool or the "geo" command.</p>
<h4 id="ddms">Using DDMS</h4>
<p>With the DDMS tool, you can simulate location data a few different ways:</p>
<ul>
<li>Manually send individual longitude/latitude coordinates to the device.</li>
<li>Use a GPX file describing a route for playback to the device.</li>
<li>Use a KML file describing individual placemarks for sequenced playback to the device.</li>
</ul>
<p>For more information on using DDMS to spoof location data, see the
<a href="{@docRoot}reference/ddms.html#emulator-control">Using DDMS guide</a>.
<h4 id="geo">Using the "geo" command</h4>
<p>Launch your application in the Android emulator and open a terminal/console in
your SDK's <code>/tools</code> directory. Now you can use:</p>
<ul><li><code>geo fix</code> to send a fixed geo-location.
<p>This command accepts a longitude and latitude in decimal degrees, and
an optional altitude in meters. For example:</p>
<pre>geo fix -121.45356 46.51119 4392</pre>
</li>
<li><code>geo nmea</code> to send an NMEA 0183 sentence.
<p>This command accepts a single NMEA sentence of type '$GPGGA' (fix data) or '$GPRMC' (transit data).
For example:</p>
<pre>geo nmea $GPRMC,081836,A,3751.65,S,14507.36,E,000.0,360.0,130998,011.3,E*62</pre>
</li>
</ul>