FIND Documentation
Have you ever wanted to…
- do home automation without motion sensors?
- track your phone or laptop indoors without GPS?
- monitor the whereabouts and trajectories of cell phones?
FIND stands for the Framework for Internal Navigation and Discovery, which is an attempt to implement a solution to these questions. This version, FIND3, is v3.X of FIND (the latest version).
To get started, read the documentation and take a look at the repo. The easiest way to start is to read Tracking your phone.
Introduction
The FIND3 Overview document provides a high-level
introduction to FIND3.
It is a good place to start to learn about the motivation for the project
and overall design.
It also has introductions to many of the other topics explored in more
detail in the other documents.
The FAQ answers common questions about FIND3.
The Machine learning guide explains how the machine learning works in FIND3.
User guide
The Tracking your phone document describes how to get started tracking your phone (most people should start here).
The Tracking your computer explains how to install and run the software for using your computer for internal positioning.
The Passive tracking document instructs how to get started to track any phones in a vicinity.
The API document has a detailed guide on how to access the FIND3 data after tracking/learning.
The MQTT document will explain how to subscribe to FIND using MQTT.
System
The find3-cli-scanner is a CLI tool for scanning fingerprints from your computer.
The find3-server document explains how
to set up your own FIND3 installation on a Linux server.
The esp-client is a repo that can be used to setup a scanner using ESP8266/ESP32.
Applications
- The Home Automation document describes the basics for getting started with FIND and openHAB or Home Assistant.
Community
FIND3 is an open source project with a growing community
of users and contributors.
These resources support the open source project and
point to things such as the GitHub repository,
mailing lists, user forums, and so on.