https://github.com/runeharlyk/hamster-pedometer

https://github.com/runeharlyk/hamster-pedometer

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/runeharlyk/hamster-pedometer
• Owner: runeharlyk
• License: other
• Created: 2024-10-05T11:37:27.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-25T10:39:53.000Z (2 months ago)
• Last Synced: 2024-10-27T13:16:18.378Z (2 months ago)
• Language: C
• Size: 5.69 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


    Hamster - Pedometer 🐹💨👟

  


Ever wondered how long your hamster is running?




  Overview •

  Key Features •

  

  Credits •

  License



[![Frontend Tests](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/frontend-tests.yml/badge.svg)](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/frontend-tests.yml)

[![PlatformIO CI](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/embedded-build.yml/badge.svg)](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/embedded-build.yml)



## 📜 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



### 📈 Statistics



## 🔮 Getting started

1. Clone and open the new project

   ```sh

   git clone https://github.com/runeharlyk/hamster-pedometer

   ```

1. Install dependencies with preferable package manager (npm, pnpm, yarn)

   ```sh

   cd app

   pnpm install

   ```

1. Configure device settings

   1. Update `factory_settings.ini` with relevant settings

1. Upload filesystem image using platformIO

1. Upload firmware using platformIO

## 🚀 Future

See the [open issues](https://github.com/runeharlyk/hamster-pedometer/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](https://github.com/runeharlyk/SpotMicroESP32-Leika)

## ☕ Support

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



## 📃 License

[MIT](LICENSE.md)

---

> [runeharlyk.dk](https://runeharlyk.dk)  · 

> GitHub [@runeharlyk](https://github.com/runeharlyk)  · 

> LinkedIn [@Rune Harlyk](https://www.linkedin.com/in/rune-harlyk/)