mirror of
https://github.com/malmeloo/FindMy.py.git
synced 2026-04-17 21:53:57 +02:00
docs: Move related projects to dedicated docs page
This commit is contained in:
17
README.md
17
README.md
@@ -5,7 +5,7 @@
|
|||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
_Query Apple's FindMy network with Python!_
|
_Query Apple's FindMy network with Python!_
|
||||||
|
|
||||||
<h5>
|
<h5>
|
||||||
<a href="https://docs.mikealmel.ooo/FindMy.py">
|
<a href="https://docs.mikealmel.ooo/FindMy.py">
|
||||||
@@ -26,6 +26,7 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
## 🚀 Overview
|
## 🚀 Overview
|
||||||
|
|
||||||
The current "Find My-scene" is quite fragmented, with code
|
The current "Find My-scene" is quite fragmented, with code
|
||||||
being all over the place across multiple repositories,
|
being all over the place across multiple repositories,
|
||||||
written by [several authors](#Credits). This project aims to
|
written by [several authors](#Credits). This project aims to
|
||||||
@@ -36,7 +37,7 @@ application wishing to integrate with the Find My network.
|
|||||||
> This project is currently in Alpha. While existing functionality
|
> This project is currently in Alpha. While existing functionality
|
||||||
> will likely not change much, the API design is subject to change
|
> will likely not change much, the API design is subject to change
|
||||||
> without prior warning.
|
> without prior warning.
|
||||||
>
|
>
|
||||||
> You are encouraged to report any issues you can find on the
|
> You are encouraged to report any issues you can find on the
|
||||||
> [issue tracker](https://github.com/malmeloo/FindMy.py/issues/)!
|
> [issue tracker](https://github.com/malmeloo/FindMy.py/issues/)!
|
||||||
|
|
||||||
@@ -45,7 +46,7 @@ application wishing to integrate with the Find My network.
|
|||||||
- [x] Cross-platform: no Mac needed
|
- [x] Cross-platform: no Mac needed
|
||||||
- [x] Fetch and decrypt location reports
|
- [x] Fetch and decrypt location reports
|
||||||
- [x] Official accessories (AirTags, iDevices, etc.)
|
- [x] Official accessories (AirTags, iDevices, etc.)
|
||||||
- [x] Custom AirTags (OpenHaystack)
|
- [x] Custom AirTags (OpenHaystack)
|
||||||
- [x] Apple account sign-in
|
- [x] Apple account sign-in
|
||||||
- [x] SMS 2FA support
|
- [x] SMS 2FA support
|
||||||
- [x] Trusted Device 2FA support
|
- [x] Trusted Device 2FA support
|
||||||
@@ -86,14 +87,8 @@ before committing it.
|
|||||||
|
|
||||||
## 🧠 Derivative projects
|
## 🧠 Derivative projects
|
||||||
|
|
||||||
There are several other cool projects based on this library! Some of them have been listed below, make sure to check them out as well.
|
There are several other cool projects in the FindMy space!
|
||||||
|
You can check them out [here](http://docs.mikealmel.ooo/FindMy.py/related/index.html).
|
||||||
* [OfflineFindRecovery](https://github.com/hajekj/OfflineFindRecovery) - Set of scripts to precisely locate your lost MacBook.
|
|
||||||
* [SwiftFindMy](https://github.com/airy10/SwiftFindMy) - Swift port of FindMy.py.
|
|
||||||
* [FindMy Home Assistant (1)](https://github.com/malmeloo/hass-FindMy) - Home Assistant integration made by the author of FindMy.py.
|
|
||||||
* [FindMy Home Assistant (2)](github.com/krmax44/homeassistant-findmy) - Home Assistant integration made by [krmax44](https://github.com/krmax44).
|
|
||||||
* [OpenTagViewer](https://github.com/parawanderer/OpenTagViewer) - Android App to locate your AirTags.
|
|
||||||
* [Find My Dad](https://github.com/NickCrews/findmydad) - Geofencing application for AirTags using Google Sheets and SMS.
|
|
||||||
|
|
||||||
## 🏅 Credits
|
## 🏅 Credits
|
||||||
|
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ Home <self>
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
getstarted/index
|
getstarted/index
|
||||||
|
related/index
|
||||||
technical/index
|
technical/index
|
||||||
reveng/index
|
reveng/index
|
||||||
```
|
```
|
||||||
|
|||||||
1
docs/related/50-projects.md
Normal file
1
docs/related/50-projects.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# Test
|
||||||
88
docs/related/index.md
Normal file
88
docs/related/index.md
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
# Related Projects
|
||||||
|
|
||||||
|
FindMy.py is not the only project that's active in the Find My scene, nor is it the first.
|
||||||
|
This page serves as a showcase of all the amazing projects that people are working on.
|
||||||
|
|
||||||
|
Projects are grouped by category and ordered by date of insertion.
|
||||||
|
Projects with a snake emoji (🐍) prepended to their name are either using or based on FindMy.py.
|
||||||
|
Want to add your own project to the list?
|
||||||
|
Create an issue, PR or shoot me a message on [Discord](https://discord.gg/EF6UCG2TF6).
|
||||||
|
|
||||||
|
## Research / Proof of Concepts
|
||||||
|
|
||||||
|
#### [OpenHaystack](https://github.com/seemoo-lab/openhaystack/)
|
||||||
|
|
||||||
|
_Author: [seemo-lab](https://github.com/seemo-lab)_
|
||||||
|
|
||||||
|
The original FindMy project that started it all. Seemo-lab originally used an Apple Mail plug-in to
|
||||||
|
obtain the authentication tokens necessary to request device locations.
|
||||||
|
|
||||||
|
OpenHaystack also includes scripts and firmware to turn devices such as the Micro:Bit and
|
||||||
|
generic Linux devices into DIY AirTags.
|
||||||
|
|
||||||
|
#### [FindMy](https://github.com/beimster/FindMy/)
|
||||||
|
|
||||||
|
_Author: [biemster](https://github.com/biemster)_
|
||||||
|
|
||||||
|
After [JJTech](https://github.com/JJTech0130/) discovered how to obtain the authentication tokens
|
||||||
|
without using a Mac, biemster published his "FindMy" project. It was one of the first scripts that was
|
||||||
|
able to query locations for DIY AirTags without needing access to a Mac.
|
||||||
|
|
||||||
|
Fun fact: FindMy.py originally started as an adoptation of biemster's FindMy, but refactored as a Python library.
|
||||||
|
Since then, FindMy.py has deviated from biemster's project somewhat. FindMy.py solely focuses on querying device locations
|
||||||
|
and has added support for local Bluetooth scanning and official AirTags, while biemster's FindMy mainly focuses on
|
||||||
|
DIY tags, and includes firmware for some embedded devices to turn them into AirTags.
|
||||||
|
|
||||||
|
## Location Tracking
|
||||||
|
|
||||||
|
#### 🐍 [hass-FindMy](https://github.com/malmeloo/hass-FindMy)
|
||||||
|
|
||||||
|
_Author: [malmeloo](https://github.com/malmeloo/)_
|
||||||
|
|
||||||
|
Home Assistant integration made by the author of FindMy.py that allows you to track your devices as device tracker entities.
|
||||||
|
FindMy.py is continuously updated to ensure compatibility with Home Assistant's requirements and to minimize breakage
|
||||||
|
due to dependency conflicts.
|
||||||
|
|
||||||
|
#### 🐍 [OfflineFindRecovery](https://github.com/hajekj/OfflineFindRecovery)
|
||||||
|
|
||||||
|
_Author: [hajekj](https://github.com/hajekj/)_
|
||||||
|
|
||||||
|
Set of scripts meant to precisely locate a lost MacBook.
|
||||||
|
|
||||||
|
#### 🐍 [homeassistant-FindMy](https://github.com/krmax44/homeassistant-findmy)
|
||||||
|
|
||||||
|
_Author: [krmax44](https://github.com/krmax44/)_
|
||||||
|
|
||||||
|
Home Assistant integration to track your FindMy devices.
|
||||||
|
|
||||||
|
#### 🐍 [OpenTagViewer](https://github.com/parawanderer/OpenTagViewer)
|
||||||
|
|
||||||
|
_Author: [parawanderer](https://github.com/parawanderer/)_
|
||||||
|
|
||||||
|
Android app that allows you to track your FindMy devices.
|
||||||
|
|
||||||
|
#### 🐍 [Find My Dad](https://github.com/NickCrews/findmydad)
|
||||||
|
|
||||||
|
_Author: [NickCrews](https://github.com/NickCrews/)_
|
||||||
|
|
||||||
|
Geofencing application for AirTags using Google Sheets and SMS.
|
||||||
|
|
||||||
|
#### 🐍 [FindMy-Dashboard](https://github.com/Philip2809/FindMy-Dashboard)
|
||||||
|
|
||||||
|
_Author: [Philip2809](https://github.com/Philip2809/)_
|
||||||
|
|
||||||
|
Web dashboard to view the location of your FindMy devices on a map.
|
||||||
|
|
||||||
|
#### 🐍 [LockMyTag](https://github.com/pablobuenaposada/LockMyTag)
|
||||||
|
|
||||||
|
_Author: [pablobuenaposada](https://github.com/pablobuenaposada/)_
|
||||||
|
|
||||||
|
Geofencing for FindMy devices. Also includes a map to view device locations.
|
||||||
|
|
||||||
|
## Libraries
|
||||||
|
|
||||||
|
#### 🐍 [SwiftFindMy](https://github.com/airy10/SwiftFindMy)
|
||||||
|
|
||||||
|
_Author: [Airy10](https://github.com/airy10/)_
|
||||||
|
|
||||||
|
Swift port of FindMy.py
|
||||||
Reference in New Issue
Block a user