https://github.com/schollz/find
High-precision indoor positioning framework for most wifi-enabled devices.
https://github.com/schollz/find
gps-tracker location-services motion-sensors wifi-fingerprints
Last synced: 2 months ago
JSON representation
High-precision indoor positioning framework for most wifi-enabled devices.
- Host: GitHub
- URL: https://github.com/schollz/find
- Owner: schollz
- License: agpl-3.0
- Created: 2015-10-20T20:54:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-09-07T11:35:54.000Z (almost 3 years ago)
- Last Synced: 2025-04-13T01:59:46.595Z (2 months ago)
- Topics: gps-tracker, location-services, motion-sensors, wifi-fingerprints
- Language: Go
- Homepage: https://www.internalpositioning.com/
- Size: 8.96 MB
- Stars: 5,061
- Watchers: 178
- Forks: 368
- Open Issues: 86
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
#  FIND
[](https://www.internalpositioning.com/guide/development/)
[](https://github.com/schollz/find/releases)
[](https://www.internalpositioning.com/)
[](https://www.paypal.me/ZackScholl/5.00)
[](https://saythanks.io/to/schollz)
[](https://www.internalpositioning.com/)
**Keywords**: indoor GPS, WiFi positioning, indoor mapping, indoor navigation, indoor positioning
# There is a new version, [FIND3](https://github.com/schollz/find3). It has [numerous improvements](https://www.internalpositioning.com/doc/overview.md#new-version) over this version.
# About
**The Framework for Internal Navigation and Discovery** (_FIND_) allows you to use your (Android) smartphone or WiFi-enabled computer (laptop or Raspberry Pi or etc.) to determine your position within your home or office. You can easily use this system in place of motion sensors as its resolution will allow your phone to distinguish whether you are in the living room, the kitchen or the bedroom, etc. The position information can then be used in a variety of ways including home automation, way-finding, or tracking!
> Simply put, FIND will allow you to replace _tons_ of motion sensors with a _single_ smartphone!
The system is built on two main components - [a server](https://ml.internalpositioning.com/) and a fingerprinting device. The fingerprinting device ([computer program](https://github.com/schollz/find/releases/tag/v0.5) or [android app](https://play.google.com/store/apps/details?id=com.hcp.find)) sends the specified data to the machine learning server which stores the fingerprints and analyzes them. It then returns the result to the device and stores the result on the server for accessing via a web browser or triggering via hooks.
**FAQ (abbreviated)**:
- How does it work? It uses already available WiFi information to classify locations. [See here for more detailed information](https://www.internalpositioning.com/faq/#how-does-it-work).
- Doesn't this already exist? [Yes, kinda](https://www.internalpositioning.com/faq/#doesnt-this-already-exist).
- What's the point? This short piece of code can do [home automation](https://www.internalpositioning.com/faq/#can-i-run-the-server-at-home-on-the-lan-connection) and [replace motion sensors](https://www.internalpositioning.com/faq/#can-it-replace-motion-sensors) and [more](https://www.internalpositioning.com/faq/#whats-the-point-of-this).
- Can I use an iPhone? [Sorry, no](https://www.internalpositioning.com/faq/#can-i-use-an-iphone).
- Does it work on a Raspberry Pi? [Yes](https://www.internalpositioning.com/faq/#can-you-run-the-server-on-a-raspberry-pi).
- Does it work with [home-assistant.io](https://home-assistant.io/)? [Yes](https://www.internalpositioning.com/faq/#does-it-work-with-home-assistantio).
- Can I help? [Yes, please](https://github.com/schollz/find/issues).
- How do I try it? It's easy. Just [download and run](https://github.com/schollz/find#usage).
More questions? See the [unabbreviated FAQ](https://www.internalpositioning.com/faq/).
# Quickstart
If you'd like to install things yourself, see [the documentation](https://www.internalpositioning.com/setup/). You don't need to do this to try it though. Follow the 3 steps below to get started quickly.
## 1\. Download the software
**Android users:** [download the current version of the app](https://play.google.com/store/apps/details?id=com.hcp.find). _Sorry iPhone users but [the Apple store prevents apps that access WiFi information](https://www.internalpositioning.com/faq/#can-i-use-an-iphone), so I will be unable to release a iPhone version._
**OR**
**Computer users:** you can [download the current version of the fingerprinting program](https://github.com/schollz/find/releases/tag/v0.5), available for Rasbperry Pi, OSX, Linux, and Windows.
## 2\. Gather fingerprint data
First, to get started using **FIND** you will need to gather fingerprint data in your locations.
**Android users:** When you start up the app you will be asked for a username (enter whatever you want) and you'll be assigned a unique group name. Simply click "Learn" and you'll be prompted for a location name. After you enter a location, the app will connect to the server and then submit fingerprints.
**Computer users:** To start learning locations simply use `./fingerprint -e`.
## 3\. Track yourself
Once you've collected data in a few locations, you can track yourself.
**Android users:** Just press the "Track" button when you're ready to track.
**Computer users:** Type in `./fingerprint` to start tracking yourself.
# More information
See the documentation at .
# Acknowledgements
 Funding from [Duke University Colab](https://colab.duke.edu/)
Thanks to [tscholl2](https://github.com/tscholl2), [sjsafranek](https://github.com/sjsafranek), and [jschools](https://github.com/jschools) for their help in guiding the development of **FIND** and creating the early versions of FIND with me! Thanks to Rishabh Rajgarhia and [CanvasJS](http://canvasjs.com/) for help implementing a nice graph. Thanks [arafsheikh](https://github.com/arafsheikh) for adding interface selection, [Pugio](https://github.com/Pugio) and [ScottSWu](https://github.com/ScottSWu) for adding OS X/Windows support for the fingerprint program, including a better [Windows scanning utility](https://github.com/ScottSWu/windows-wlan-util/releases)! Thanks [Thom-x](https://github.com/Thom-x) for the Dockerfile. Thanks [certifiedloud](https://github.com/certifiedloud) for implementing the change to `DELETE` requests and implementing sockets for unix. Thanks [bebus77](https://github.com/bebus77) for making a awesome generic struct for OS support on the fingerprinting program! Thanks [christoph-wagner](https://github.com/Christoph-Wagner) for help with polling interval on app. Thanks to [patorjk](http://patorjk.com/software/taag/) and [asciiworld](http://www.asciiworld.com/) for the ASCII art. Thanks to [Imgur](https://imgur.com/a/yjvci) for [hosting](https://imgur.com/a/3yGjV) images.
## Donate
Like this? Help me keep it alive [by donating $5](https://www.paypal.me/ZackScholl/5.00) to [pay for server costs](http://rpiai.com/donate/).