Skip to content

LioExp/MyFi

Repository files navigation

MyFi

Python 3.8+ Version License: MIT LioExp

read in Portuguese


I discovered unknown devices on my network. I built this to solve the problem.

MyFi is a modular observability platform for small local networks. It discovers devices, monitors traffic, enforces usage limits, and sends real‑time alerts — with an extensible architecture based on Chunks.


✨ Features

  ┌─────────────────────────────────────────────────────────┐
  │  myfi v2.0.0                                            │
  │                                                         │
  │  ✓  Interactive setup wizard                            │
  │  ✓  Device discovery (IP, MAC, interface)               │
  │  ✓  Per‑device traffic monitoring                       │
  │  ✓  Configurable limits with Telegram alerts            │
  │  ✓  CLI with verbosity levels (-q, -v, -vv)             │
  │  ✓  SQLite persistence                                  │
  └─────────────────────────────────────────────────────────┘

📦 Installation

git clone https://github.com/lioexp/myfi.git
cd myfi/ && make setup
myfi setup

🚀 Usage

1. Initial setup

python main.py setup

The wizard will ask:

  • Device type (local PC, hotspot, router)
  • Network interface to monitor
  • Telegram bot credentials (optional)

2. Network scan

python main.py

3. Traffic monitoring

myfi monitor start            # low‑power mode (5 min interval)
myfi monitor start --live     # real‑time (2s window)
myfi monitor stop
myfi monitor report

4. Limit management

myfi limit set --mac aa:bb:cc:dd:ee:ff --daily 200
myfi limit show
myfi limit remove --mac aa:bb:cc:dd:ee:ff

At 80% of the limit → Telegram alert. At 100% → critical alert + device blocked.


🗺️ Roadmap

  v0.5  ██████████  ✅  Setup wizard
  v1.0  ██████████  ✅  Network scanner
  v2.0  ██████████  ✅  Traffic monitoring, limits, alerts
  v3.0  ░░░░░░░░░░  ⏳  Chunk system (modular automation)
  v4.0  ░░░░░░░░░░  ⏳  AI anomaly detection
  v5.0  ░░░░░░░░░░  ⏳  Graphical interface

🤝 Contributing

Contributions are welcome. See CONTRIBUTING.md.


// build. break. document.  ·  Col 3:23

About

MyFi is a modular observability and automation platform for small local networks. It focuses on device visibility, traffic monitoring, and real-time alerts — with an extensible architecture built around Chunks.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors