FIND

FIND is now 100% open-source.

Note for past users, the codebase has been completely rewritten in Golang so things are ~100x faster, smarter, and more secure. The Python3 version will stay available, but it is no longer supported. Development will now be focused on this version.

Keywords: indoor GPS, WiFi positioning, indoor mapping, indoor navigation, indoor positioning

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 and a fingerprinting device. The fingerprinting device (computer or android app) 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):

• Doesn't this already exist? Yes, kinda.
• Can I use an iPhone? Sorry, no.
• Does it work on a Raspberry Pi? Yes.
• Whats the point of this? This short piece of code can do home automation and replace motion sensors and more.
• Can I help? Yes, please.

More questions? See the unabbreviated FAQ.

Features

• SSL support
• Compression to keep DBs small
• Fast (20-200x faster than the previous Python version)
• Mixes two machine learning algorithms for best classifications
• Bug free (yeah, um...probably not. Please submit an issue when you find one).

Requirements

To use this system you need to have the following:

• (Optional) Server: A computer (OS X/Windows/Linux) to run the server. If you don't have this, use ours.
• Client(s): device (laptop/Raspberry Pi/Android smartphone) that has access to WiFi

Setup (optional)

The tools are prebuilt, so you can skip to the Usage section if you just want to try it out.

Server

First install Go if you haven't already. FIND is tested on Go version 1.5+.

$ git clone https://github.com/schollz/find.git
$ cd find
$ go get ./...
$ go build

Then to run,

$ ./find
-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----
   _________  _____
  / __/  _/ |/ / _ \  ______ _____  _____ ____
 / _/_/ //    / // / (_-< -_) __/ |/ / -_) __/
/_/ /___/_/|_/____/ /___|__/_/  |___/\__/_/

(version 2.X) is up and running on http://192.168.1.2:8003
-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----

Client

The client gathers WiFi fingerprints and sends them to the server. There are two clients - one for an Android smartphone, and one for a WiFi-enabled computer. Check out the individual repos to get started on either/both:

• FIND app client
• FIND program client

Usage

Gather fingerprint data

To get started using FIND you will need one of the client programs. The client programs gather WiFi fingerprints and locations and sends them to a server. There is a client for Android smartphones, and one for WiFi enabled computers.

Client (for Android smartphones)

Sorry iPhone users but the Apple store prevents apps that access WiFi information, so I will be unable to release a iPhone version.

To get started using FIND on a smartphone, download the latest app or build it yourself.

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. Then you'll see the following:

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. After you've learned some locations, just hit "Track" and you'll see your calculated location.

To see more detailed information, go to the server and login with your group name

Client (for computers)

Supports Linux, Windows, Raspberry Pi. Sorry, OS X is not yet supported - please help me add it!

To get started, download the program here or build it yourself. To start learning locations simply use

./fingerprint -e

and then to track your location use

./fingerprint

There are other options, you can learn more by typing ./fingerprint --help. When you start learning/tracking, you can see more detailed information by logging into the server and login with your group name.

Analyze fingerprint data

The server analyzes and helps you decipher the fingerprint data, if you are interested in that. Once you got your client you can see statistics about your fingerprints by logging on to the server and signing in with your group name. If you are using our server, login to ml.internalpositioning.com with your Group name. Otherwise, use your local version of the server.

You can see fingerprints of individual places by clicking on them, and then you can click on mac addresses to see there statistics across rooms.

Contributing

Please, do! Checkout the latest issues to see what needs being done, or add your own cool thing.

Acknowledgements

Funding from Duke University Colab

Thanks to patorjk and asciiworld for the ASCII art. Thanks to Imgur for hosting images

Donate

Like this? Help me keep it alive by donating $5 to pay for server costs.

License

Copyright 2015-2016 Zack Scholl

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License https://github.com/schollz/find/blob/master/LICENSE.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.