https://github.com/emberfox205/stalkinator
A Flask-based webapp to monitor positions using Arduino
https://github.com/emberfox205/stalkinator
flask-application gps iot-application javascript position-tracking python3 sqlalchemy sqlite3 webapp
Last synced: 7 days ago
JSON representation
A Flask-based webapp to monitor positions using Arduino
- Host: GitHub
- URL: https://github.com/emberfox205/stalkinator
- Owner: emberfox205
- License: other
- Created: 2024-06-03T15:27:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T09:37:34.000Z (almost 2 years ago)
- Last Synced: 2025-03-25T13:48:19.085Z (over 1 year ago)
- Topics: flask-application, gps, iot-application, javascript, position-tracking, python3, sqlalchemy, sqlite3, webapp
- Language: JavaScript
- Homepage:
- Size: 3.06 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# stalkinator
A Flask-based web application that tracks children's location to aid parental control using Arduino Cloud.
[Github repository](https://github.com/emberfox205/stalkinator)
## Setup
### Server-side
Clone this repo:
```bash
git clone git@github.com:emberfox205/stalkinator.git
```
Install all the dependencies (preferably into a virtual environment):
```bash
pip install -r requirements.txt
```
Register an [Arduio Cloud](https://cloud.arduino.cc/) account and subscribe to at least the **Maker** tier.
Register for a [Geoapify](https://www.geoapify.com/) key (free of charge).
In your local repo, set up an `.env` file with the following structure:
```bash
CLIENT_ID=arduino_client_id
CLIENT_SECRET=arduino_secret
GEOAPIFY_API_KEY="geoapify_api_key"
```
Replace `arduino_client_id`, `arduino_secret` and `geoapify_api_key` with actual data.
> [!NOTE]
> The Geoapify key must be quoted.
[Optionally] Install [DB Browser for SQLite](https://sqlitebrowser.org/dl/) to manage the database with a GUI.
### Client-side
Download mobile Arduino app for the tracked target:
- [iOS AppStore](https://apps.apple.com/vn/app/arduino-iot-cloud-remote/id1514358431?l=vi)
- [Android PlayStore](https://play.google.com/store/apps/details?id=cc.arduino.cloudiot&hl=en)
Turn the device into a Thing/Device and note the Thing ID to register on the web application.
> [!NOTE]
> When registering on the webpage, your email **matters** as emails informing whether the tracked target has left / entered safezone or entered dangerzone will be sent there. Check your spam in case you can not see them.
## Initialization
Run `app.py` for the application itself. Follow standard Flask procedures to open a localhost website. `app.py` can be run independently without Arduino data for demonstration purposes.
```bash
python app.py
```
Run `data_script.py` to interact with the Arduino Cloud API.
```bash
python data_script.py
```
> [!WARNING]
>
> - Only the Billiards category in the Dangerzone tab is functional. Other options are for demonstration.
> - Options in the Settings tab are for demonstration purposes only. They are, for now, out of scope of the project.
## Credits
- [Arduino iot-api Python client](https://github.com/arduino/iot-client-pyhttps://github.com/arduino/iot-client-py)
- [Geoapify Places API](https://www.geoapify.com/places-api/)
- [GPS Tracking guide - Text](https://iot.microchip.com/docs/arduino/examples/GPS%20Tracker/Arduino%20Sketch)
- [GPS Tracking guide - Video](https://www.youtube.com/watch?v=WYT7r62AEYo&t=6s)
- [Icons](https://www.flaticon.com/)
- [Leafletjs](https://leafletjs.com/)
- [Map display](https://www.openstreetmap.org/)