Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rastenis/gps-scramble
A tool for controlled randomization of GPS coordinates.
https://github.com/rastenis/gps-scramble
coordinates geocoding gps spoof
Last synced: about 2 months ago
JSON representation
A tool for controlled randomization of GPS coordinates.
- Host: GitHub
- URL: https://github.com/rastenis/gps-scramble
- Owner: rastenis
- Created: 2019-07-21T09:27:12.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T04:22:28.000Z (almost 2 years ago)
- Last Synced: 2024-08-09T03:27:07.247Z (5 months ago)
- Topics: coordinates, geocoding, gps, spoof
- Language: TypeScript
- Homepage:
- Size: 711 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# gps-scramble
[](https://npmjs.org/package/gps-scramble "View this project on npm")
[](https://travis-ci.org/scharkee/gps-scramble)
[](https://coveralls.io/github/Scharkee/gps-scramble?branch=master)
[](https://david-dm.org/scharkee/gps-scramble)
A tool for controlled randomization/spoofing of GPS coordinates.
## Features
- Generate similar coordinates within a distance of given coordinates
- Location name based coordinate generation (geocoding), resolve coordinates by location name
- Generate the coordinates of a random establishment near the given coordinates
## Install
```bash
$ npm install gps-scramble
```
## Usage
```js
const { Scrambler } = require("gps-scramble");
let scrambler = new Scrambler([40.758896, -73.98513]);
console.log(scrambler.within(100, "m")); // randomized location within 100 meters from given coordinates.
console.log(scrambler.near()); // randomized location near given coordinates.
```
## Advanced usage (Geocoding)
```js
const { ScramblerAsync } = require("gps-scramble");
let scrambler = new ScramblerAsync("Times Square");
let location = await scrambler.within(100, "m");
console.log(location.x, location.y); // randomized location within 100 meters from Times Square
location = await scrambler.near();
console.log(location.x, location.y); // randomized location near Times Square
location = await scrambler.nearbyEstablishment();
console.log(location.x, location.y); // randomized location of a business near Times Square
```
## Geocoding support
To enable geocoding support (powered by Bing Maps Geocoding API), you must get an API key.
The process of getting a key is described [here](https://docs.microsoft.com/en-us/bingmaps/getting-started/bing-maps-dev-center-help/getting-a-bing-maps-key)
The key must be loaded as an enviromental variable named `BING_API_KEY`.
## Units
Supported units are: "mm" - milimeters, "cm" - centimeters, "m" - meters (default), "dm" - decimeters, "km" - kilometers.
## API
[API reference docs.](https://scharkee.github.io/gps-scramble/)
All gps-scrambler methods return Location objects, which contain coordinates.
They can be accessed like this:
```js
const { Scrambler } = require("gps-scramble");
let scrambler = new Scrambler([40.758896, -73.98513]);
let location = scrambler.near();
location.x; // X coordinate
location.y; // Y coordinate
location[0]; // X coordinate alternative
location[1]; // Y coordinate alternative
```
The same method for access works with scramblers themselves. Their initial states can be accessed like so:
```js
const { Scrambler } = require("gps-scramble");
let scrambler = new Scrambler([40.758896, -73.98513]);
scrambler.x; // initial X coordinate
scrambler.y; // initial Y coordinate
// ...
```
### Support
Submit bugs and requests through the project's issue tracker:
[](https://github.com/Scharkee/gps-scramble/issues)