ctw8989 / luci-wrtbwmon

Bandwidth tracker for OpenWRT that uses wrtbwmon

Bandwidth tracker for OpenWRT

This Luci module uses wrtbwmon to track bandwidth usage.

Features

• Auto refresh every 5 seconds (can be changed)
• Track speed per client (if auto refresh is enabled)
• No cron job required (wrtbwmon is updated on demand)

After installation you will see a new Usage menu item inside the Network menu list in the Luci GUI.

What it does

It displays a table that includes all columns wrtbwmon provides, with two additional ones (emphasis given):

1. Client
2. Download speed
3. Upload speed
4. Total downloaded
5. Total uploaded
6. Total usage
7. First seen date
8. Last seen date

How it works

The download/upload speed is calculated in memory on the front end using JS thus minimizing resource consumption on the router. To properly calculate these values an auto refresh interval must be set that runs the following commands on the router:

• wrtbwmon update /tmp/usage.db
• wrtbwmon publish /tmp/usage.db /tmp/usage.htm

For the above commands to work the only requirement is that the wrtbwmon package is installed and enabled.

Install

Step 1 - install the wrtbwmon package (if you have it installed skip to Step 2):

• Download the latest .ipk file from wrtbwmon releases
• Copy the file to your router /tmp directory
  • I use the following command: scp wrtbwmon_*_all.ipk [email protected]:/tmp/
• Install the package opkg install /tmp/wrtbwmon_*_all.ipk

Step 2 - setup* the wrtbwmon package:

• If you have wrtbwmon version 0.35 the init script uses wrtbwmon.sh where it was renamed to wrtbwmon
  • to fix: sed -i 's/wrtbwmon\.sh/wrtbwmon/g' /etc/init.d/wrtbwmon
• Schedule it to run on startup /etc/init.d/wrtbwmon enable
• Manually start it now /etc/init.d/wrtbwmon start

*If you have already setup a cron job to update the wrtbwmon database, it would be best if you removed it

Step 3 - install this module:

• Copy the contents of this repo's folder luci-wrtbwmon/luasrc/ to the /usr/lib/lua/luci/ router's folder

TODO

• Create an .ipk package of this module, to ease installation
• Add the .ipk package to the OpenWRT feed

Contribute

Feel free to contribute on any of the above TODO items, or even on any feature you might think is helpful. I would appreciate any help.

Credits

A big thanks to pyrovski for creating wrtbwmon and to the OpenWRT organization for creating and maintaining openwrt and luci