Skip to content

runeharlyk/Hamster-Pedometer

Repository files navigation

Hamster - Pedometer 🐹💨👟

Ever wondered how long your hamster is running?

OverviewKey FeaturesCreditsLicense

Frontend Tests PlatformIO CI

📜 Overview

This project aim to track hamsters routine, health and running stats. Built on an ESP32 with an external hall effect sensor and a couple of small magnets, it aims to be both affordable and accessible.

🎯 Features

  • Real-Time Data: Get real-time updates of your hamsters activities.
  • Statistical analysis: See statistical data.
  • Nice UI: Beatify, responsive UI.
  • Highly customizable
  • Simple setup: Flash the device and start your tracking journey.

🐹 Live hamster feed

current_session

📈 Statistics

current_session

🔮 Getting started

  1. Clone and open the new project

    git clone https://github.com/runeharlyk/hamster-pedometer
  2. Install dependencies with preferable package manager (npm, pnpm, yarn)

    cd app
    pnpm install
  3. Configure device settings

    1. Update factory_settings.ini with relevant settings
  4. Upload filesystem image using platformIO

  5. Upload firmware using platformIO

🚀 Future

See the open issues for full list of proposed and active features (and known issues).

🙌 Credits

This project takes great inspiration from the following resources:

  1. Spot Micro - Leika

☕ Support

If you like the project and want to follow it evolving concidering ✨-ing the project

Buy Me A Coffee

📃 License

MIT


runeharlyk.dk  ·  GitHub @runeharlyk  ·  LinkedIn @Rune Harlyk

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published