net.md

   1 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
   2
   3 Monitors network interfaces and shows current traffic in a textbox.
   4
   5     mynet = lain.widgets.net()
   6
   7 ### input table
   8
   9 Variable | Meaning | Type | Default
  10 --- | --- | --- | ---
  11 `timeout` | Refresh timeout seconds | int | 2
  12 `iface` | Network device | string | autodetected
  13 `units` | Units | int | 1024 (kilobytes)
  14 `settings` | User settings | function | empty function
  15
  16 Possible other values for `units` are 1 (byte) or multiple of 1024: 1024^2 (mb), 1024^3 (gb), and so on.
  17
  18 `settings` can use the following `iface` related strings:
  19
  20 - `net_now.carrier` ("0", "1");
  21 - `net_now.state` ("up", "down");
  22 - `net_now.sent` and `net_now.received` (numbers).
  23
  24 ### output
  25
  26 A textbox.