PET LOCATION

Iot project for the location of pets, using esp32 and firebase
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Pet Location is an IoT project that allows families to track the location of their pets. It uses an ESP32 microcontroller with GPS and WiFi modules to periodically send location data to a backend server. A React web application is used to display the location data on a map, and provide notifications when the pet leaves or enters designated areas.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• 
• 
• 

(back to top)

Getting Started

To use Pet Location, you will need an ESP32 microcontroller with GPS and WiFi modules, and a backend server with a database and API. You will also need to set up the React web application and configure it to communicate with the backend server.

Prerequisites

1. Node.js (https://nodejs.org/)
2. ESP32 microcontroller with GPS and WiFi modules
3. Backend server with a database and API (e.g. Node.js with MongoDB and Express)
4. Google Maps API key (https://developers.google.com/maps/gmp-get-started)

Create a Thingspeak account and channel:

1. Create a Thingspeak account (https://thingspeak.com/)
2. Create a new channel
3. Add the following fields to the channel:
   • Latitude
   • Longitude
   • Timestamp
   • Pet Name
   • Pet Status
4. Create a new API key for the channel
5. Copy the API key and channel ID
6. Paste the API key and channel ID into the ESP32 code
7. Paste the API key into the React web application code

Installation

Follow the steps:.

1. Clone the repo

   git clone https://github.com/AndresDiagoM/pet_location

2. Install NPM packages

   npm install

3. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

1. Connect the ESP32 microcontroller to your pet's collar or harness
2. Turn on the ESP32 and connect it to your WiFi network
3. The ESP32 will periodically send location data to the backend server
4. The React web application will display the pet's location on a map
5. You can set up notifications for when the pet leaves or enters designated areas

For more examples, please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

React is MIT licensed.

(back to top)

Contact

Andres Felipe Diago - @your_twitter - email@example.com

Project Link: https://github.com/AndresDiagoM/pet_location

(back to top)

Acknowledgments

The resources used to create this project are listed below.

Esp32 with GPS and WiFi modules:

• https://www.youtube.com/watch?v=9ouMjvVACnc&pp=ygUFZXNwMzI%3D

Google Maps API:

• https://developers.google.com/maps/documentation/javascript/overview

(back to top)