supleed2/ELEC60013-ES-CW1
1
0
Fork 0
mirror of https://github.com/supleed2/ELEC60013-ES-CW1.git synced 2024-12-22 13:35:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated README with project description

Browse source
This commit is contained in:
Benjamin Ramhorst 2022-06-13 12:50:39 +01:00 committed by Aadi Desai
parent b08f35aa11
commit 2b2922a226
No known key found for this signature in database
GPG key ID: CFFFE425830EF4D9
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
readme.md
View file

@ -2,12 +2,17 @@
## Project name: Barkr ## Project name: Barkr
- A pet-tracking IoT device without the need for embedded GPS - location is tracked using AirTag-style broadcasts and the FindMy network, significantly improving battery life.
- Various sensors (accelerometer, temperature, humidity) are connected to a Raspberry Pi Zero W, allowing real-time monitoring of pet's health and environment metrics.
- Data is processed and stored using a backend written in Python Flask and Firebase.
- User app, written in Flutter, allowing the user to see the current location of their pet, alongside air and skin temperature, humidity, and step count.
## Repository Sections ## Repository Sections
- [App](./App/): The user app, built in Flutter - [App](./App/): The user app, written in Flutter
- [DataPuller](./DataPuller/): Data fetching script to pull data from cloud sources and forward to our backend, eg. AirTags DB or an MQTT broker - [DataPuller](./DataPuller/): Data fetching script to pull data from cloud sources and forward to our backend, eg. AirTags DB or an MQTT broker
- [RPi](./RPi/): Program to run on the IOT device itself, collects pet information for the app and acts as a bluetooth beacon - [RPi](./RPi/): Program to run on the IOT device itself, collecting pet information for the app and acts as a bluetooth beacon
- [Server](./Server/): Backend for interacting with the Firebase API and provides user signup abilities - [Server](./Server/): Backend for interacting with the Firebase Database and providing user registration abilities
- [Website](./Website/): Static marketting website built using Hugo, live at <https://barkr.8bitsqu.id/> - [Website](./Website/): Static marketting website built using Hugo, live at <https://barkr.8bitsqu.id/>
## Contributors ## Contributors