Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twang2218/mobile-locator
Get Geolocation information based on Cell base station information
https://github.com/twang2218/mobile-locator
api cell cellocation geolocation google gpsspg gsm haoservice location mozilla mylnikov opencellid unwired unwiredlabs yandex
Last synced: about 1 month ago
JSON representation
Get Geolocation information based on Cell base station information
- Host: GitHub
- URL: https://github.com/twang2218/mobile-locator
- Owner: twang2218
- Created: 2016-05-03T13:44:04.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-03-02T13:08:58.000Z (almost 4 years ago)
- Last Synced: 2025-01-02T16:55:21.867Z (about 1 month ago)
- Topics: api, cell, cellocation, geolocation, google, gpsspg, gsm, haoservice, location, mozilla, mylnikov, opencellid, unwired, unwiredlabs, yandex
- Language: JavaScript
- Size: 167 KB
- Stars: 78
- Watchers: 10
- Forks: 35
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mobile Locator
[![NPM version][npm-version-image]][npm-url]
[![MIT License][license-image]][license-url]
[![Build Status][travis-image]][travis-url]
[![Dependency Status][dependency-image]][dependency-url]
[![Coverage Status][coverage-image]][coverage-url]
[![NPM][npm-classy-badge-image]][npm-classy-badge-url]
[license-image]: http://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat
[license-url]: LICENSE.txt
[npm-url]: https://npmjs.org/package/mobile-locator
[npm-version-image]: http://img.shields.io/npm/v/mobile-locator.svg?style=flat
[npm-downloads-image]: http://img.shields.io/npm/dm/mobile-locator.svg?style=flat
[npm-classy-badge-image]: https://nodei.co/npm/mobile-locator.png?downloads=true&downloadRank=true&stars=true
[npm-classy-badge-url]: https://nodei.co/npm/mobile-locator/
[travis-url]: http://travis-ci.org/twang2218/mobile-locator
[travis-image]: http://img.shields.io/travis/twang2218/mobile-locator.svg?style=flat
[dependency-url]: https://gemnasium.com/twang2218/mobile-locator
[dependency-image]: http://img.shields.io/gemnasium/twang2218/mobile-locator.svg
[coverage-url]: https://coveralls.io/github/twang2218/mobile-locator?branch=master
[coverage-image]: https://coveralls.io/repos/github/twang2218/mobile-locator/badge.svg?branch=master
Get geolocation from cell tower information.
Currently, the following APIs are implemented:
- `cellocation`: [Cellocation.com API (China)](http://www.cellocation.com/interfac/)
- `gpsspg`: [GPSspg.com API (China)](http://www.gpsspg.com/api/bs/)
- `google`: [Google Geolocation API](https://developers.google.com/maps/documentation/geolocation/intro)
- `haoservice`: [HaoService.com API (China)](http://www.haoservice.com/docs/1)
- `mozilla`: [Mozilla Geolocation API](https://location.services.mozilla.com/api)
- `mylnikov`: [Mylnikov Geolocation API](https://www.mylnikov.org/archives/1059)
- `opencellid`: [OpenCellID API](http://opencellid.org/)
- `unwiredlabs`: [UnwiredLabs Location API](https://unwiredlabs.com/)
- `yandex`: [Yandex Geolocation API (Russian)](https://tech.yandex.ru/locator/doc/dg/api/geolocation-api_json-docpage/)
# Library
## api(name, options)
Create the location engine by given name and options.
*Name* | *Options*
--- | ---
`cellocation` | `system`_(optional)_: Coordinate system: `wgs84`_(Default)_, `gcj02`, `bd09`.
`google` | `key`: Google API key
`gpsspg` | `key`: GPSspg API key,
`oid`: GPSspg OID,
`system`_(optional)_: Coordinate system: `0`:wgs84_(Default)_; `1`:gcj02; `2`:bd09; `3`:QQ Maps; `4`:MapBar
`haoservice` | `key`: HaoService API key,
`system`_(optional)_: Coordinate system: `0`: gcj02; `1`:bd09; `2`:wgs84_(Default)_
`mozilla` | `key`: Mozilla API key
`mylnikov` | `data`_(optional)_: `open`: Use open source data.
`opencellid` | `key`: OpenCellID API key
`unwiredlabs` | `token`: UnwiredLabs Location API token
`yandex` | `key`: Yandex API key
Besides the above engine-specific options, more general options are also available:
- `verbose`: Print more debug information if `verbose` is `true`;
- `timeout`: Set the timeout value in milliseconds. There is no timeout by default.
The returned value is a `locate()` function, which will be described in the next section.
## locate(info)
`info` should contain cell information, including `mnc`, `mcc`, `lac` and `cid`.
The function will return a promise, which will return the `location` from given geolocation service.
`location` is an object contains following properties:
*Property* | *Description*
--- | ---
`longitude` | Longitude
`latitude` | Latitude
`accuracy` | The accuracy range of the given position
`address`(optional) | For some API, this property contains the human readable address line.
## Example
```javascript
const api = require('mobile-locator');
const locate = api('google', { key: YOUR_GOOGLE_API_KEY });
locate({ mcc: 460, mnc: 0, lac: 4219, cid: 20925 })
.then(location => console.log(JSON.stringify(location, null, 2)));
```
The output would be:
```javascript
{
longitude: 116.46679499999998,
latitude: 39.9910226,
accuracy: 606
}
```
# Command-line Interface
Usage
```bash
$ mobile-locator -h
Usage: mobile-locator [options]
Locate geolocation information based on Cell base station data
Options:
-h, --help output usage information
-V, --version output the version number
-c, --cell Cell tower base station information in format "MCC,MNC,LAC,CID". "-c 460,0,4219,20925"
-e, --engine Geolocation service engine. {cellocation, google, gpsspg, haoservice, mozilla, mylnikov, opencellid, unwiredlabs, yandex}. Default: google
-a, --arguments Arguments for geolocation engine. e.g. "key:XXX,oid:123".
-m, --map Map service. {google, bing, openstreetmap, google.cn, bing.cn, baidu}.
-v, --verbose Verbose output.
Examples:
$ mobile-locator -a "key:XXX" -c 460,0,4219,20925
$ mobile-locator -e cellocation -a "system:bd09" -m baidu -c 460,0,4219,20925
```
By default, the Google Geolocation engine will be used.
```bash
$ mobile-locator -a "key:GOOGLE_API_KEY" -c 460,0,4219,20925
{"longitude":116.46679499999998,"latitude":39.9910226,"accuracy":606}
```
With verbose option:
```bash
$ mobile-locator -a "key:AIzaSyAL2sfTLqUv9Rb3ercbtuu__PG2pS_4eDo" -c 460,0,4219,20925 -v
Geolocation engine: "google"
Cell: {"mcc":"460","mnc":"0","lac":"4219","cid":"20925"}
Location: {"longitude":116.46679499999998,"latitude":39.9910226,"accuracy":606}
```
More complex example:
- Use `cellocation` engine;
- Choose `bd09` coordinate system;
- Show Baidu map url for given coordinate;
- Verbose output.
```bash
$ mobile-locator -e cellocation -a 'system:bd09' -m baidu -v -c 460,0,4219,20925
Geolocation engine: "cellocation"
Cell: {"mcc":"460","mnc":"0","lac":"4219","cid":"20925"}
Location: {"longitude":"116.479653","latitude":"39.997967","accuracy":"100","address":"北京市朝阳区望京街道望京园402号楼;广顺南大街与阜安西路路口东北109米"}
Map url: http://api.map.baidu.com/marker?location=39.997967,116.479653&title=_&content=北京市朝阳区望京街道望京园402号楼;广顺南大街与阜安西路路口东北109米&output=html&autoOpen=true
```