hnykda / wifi-heatmapper

Tool to 📏measure and generate a 🛜 WiFi connection quality heatmap over a floorplan📍

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

WiFi Heatmapper

This project is a WiFi heatmapper solution for macOS, inspired by python-wifi-survey-heatmap. I wanted to create a heatmap of my WiFi coverage, but the original project didn't work because I am running on Mac (Apple Sillicon).

Screenshot Screenshot

Recording

showcase recording

Prerequisites

  • macOS (tested on Apple M2, Sonoma 14.5)
  • npm and iperf3 installed (can be installed via brew install npm iperf3)

Installation

git clone https://github.com/hnykda/wifi-heatmapper.git
cd wifi-heatmapper
npm install

Usage

  1. Start the application from where you want to run the tests (very likely your Mac laptop so you can move around the house):

    npm run dev
  2. On a separate server that you want to run the tests against, run the following command to start the iperf3 server (you will need its IP address to be accessible from the laptop running the application):

    iperf3 -s
  3. Open a web browser and go to http://localhost:3000.

  4. Upload your floor plan image. You might have to create it using some other software, such as sweethome3d.

  5. Follow the on-screen instructions to complete the WiFi survey and generate the heatmap.

How does this work

It's actually pretty simple. The app is written in Next.js. To get the information, we invoke the iperf3, wdutil and ioreg commands via JS child_process and parse the output. The webapp then just stores everything in simple JSON "database" file.

Credits

This project was inspired by python-wifi-survey-heatmap. Special thanks to the original author for their work.

Contributing

Feel free to contribute to this project by opening an issue or submitting a pull request. I am more than happy for that!

Some ideas one could work on:

  1. extend this to work on Windows and Linux
  2. find out how to get RSSI and other stuff from ioreg so sudo is not needed (for wdutil)
  3. make the app more user-friendly and informative (step by step wizard for the measurements)
  4. serialize the image to the database file so it can be loaded later
  5. add leaflet to make the maps interactive
  6. load/save heatmap config to database

About

Tool to 📏measure and generate a 🛜 WiFi connection quality heatmap over a floorplan📍

License:MIT License


Languages

Language:TypeScript 97.5%Language:CSS 1.4%Language:JavaScript 1.1%