https://github.com/schollz/find3

High-precision indoor positioning framework, version 3.
https://github.com/schollz/find3

bluetooth gps-tracking indoor-positioning location-services motion wifi

Last synced: 22 days ago
JSON representation

High-precision indoor positioning framework, version 3.

• Host: GitHub
• URL: https://github.com/schollz/find3
• Owner: schollz
• License: mit
• Created: 2018-02-15T16:23:43.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T00:57:30.000Z (almost 2 years ago)
• Last Synced: 2024-09-30T18:03:32.696Z (about 1 month ago)
• Topics: bluetooth, gps-tracking, indoor-positioning, location-services, motion, wifi
• Language: Go
• Homepage: https://www.internalpositioning.com/doc
• Size: 19.7 MB
• Stars: 4,640
• Watchers: 108
• Forks: 365
• Open Issues: 80
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome - schollz/find3 - High-precision indoor positioning framework, version 3. (Go)
• go-awesome - FIND3 - WiFi device detection (Open source library / The Internet)

README

        
[![Version 3.0](https://img.shields.io/badge/read-docs-blue.svg?style=for-the-badge)](https://www.internalpositioning.com/doc/) 

[![Version 3.0](https://img.shields.io/badge/join-slack-orange.svg?style=for-the-badge)](https://join.slack.com/t/find3/shared_invite/enQtMzU4MjY0NjE1NjU0LWRkY2JhNWFkM2U3Y2JhY2RlZTQ5ZTdmZTQ2M2UzMjI2MGVmMjZlOWQyZmU3MzM5YzIzOTM0YmYzYmQ3NTQzNjQ) 

[![Version 3.0](https://img.shields.io/badge/version-3.3.0-brightgreen.svg?style=for-the-badge)](https://github.com/schollz/find3/releases/latest) 

[![Donate](https://img.shields.io/badge/donate-$-brown.svg?style=for-the-badge)](https://www.paypal.me/ZackScholl/5.00)

[![Say Thanks](https://img.shields.io/badge/Say%20Thanks-!-yellow.svg?style=for-the-badge)](https://saythanks.io/to/schollz)

**The Framework for Internal Navigation and Discovery** (_FIND_) is like indoor GPS for your house or business, using only a simple smartphone or laptop.

> This version, 3.X, is a complete re-write of the [previous versions 2.x](https://github.com/schollz/find).

# About the project

This repository is a complete re-write of the previous version of FIND ([github.com/schollz/find](https://github.com/schollz/find)). There are notable improvements from the previous version:

- Support for any data source - Bluetooth / WiFi / magnetic fields / etc. (previously just WiFi)

- Passive scanning built-in (previously required a [separate server](https://github.com/schollz/find-lf))

- Support for Bluetooth scanning in scanning utility (previously just WiFi)

- Meta-learning with 10 different machine learning classifiers (previously just three)

- Client uses Websockets+React which reduces bandwidth (and coding complexity)

- Rolling compression of MAC addresses for much smaller on-disk databases (see [stringsizer](https://github.com/schollz/stringsizer))

- Data storage in SQLite-database (previously it was BoltDB)

- Released under MIT license (more commercially compatible than AGPL)

The API for sending fingerprints (`/track` and `/learn`) and MQTT endpoints are backward compatible. 

# Status

*FIND3* is stable and ready for use.

# Contributing

*FIND3* is a framework with multiple components. There are multiple repositories that have the components, including:

- Data storage server [(this repo)](https://github.com/schollz/find3/tree/master/server/main)

- Machine learning server [(this repo)](https://github.com/schollz/find3/tree/master/server/ai)

- Command-line tool for gathering fingerprints [(schollz/find3-cli-scanner)](https://github.com/schollz/find3-cli-scanner)

- Android app for gathering fingerprints [(schollz/find3-android-scanner)](https://github.com/schollz/find3-android-scanner)

- ESP code for gathering fingerprints with ESP8266/ESP32 [(DatanoiseTV/esp-find3-client)](https://github.com/DatanoiseTV/esp-find3-client)

## Reporting issues

Please report issues through [this repo's issue tracker](https://github.com/schollz/find3).

# Community

Subscribe to the [Slack channel](https://join.slack.com/t/find3/shared_invite/enQtMzU4MjY0NjE1NjU0LWRkY2JhNWFkM2U3Y2JhY2RlZTQ5ZTdmZTQ2M2UzMjI2MGVmMjZlOWQyZmU3MzM5YzIzOTM0YmYzYmQ3NTQzNjQ) to get latest information about the project and get help.

Use the [FIND mailing list](http://eepurl.com/bhfFI1) for discussion about use and development.

# License 

MIT