Redesign message format

[khatus.git] / README.md

diff --git a/README.md b/README.md
index cc4976d..c02c1f8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,16 +10,35 @@ Experimental system-monitor and status (bar) reporter I use with
 Usage
 -----
 
+### Build
+
+`make build`
+
+### Install
+
+To copy everything from `./bin` to `$HOME/bin`:
+
+`make install`
+
+### Use
+
 In my `~/.xinitrc` I have something like the following:
 
 ```sh
 ( $BIN/khatus \
-    --wifi_interface 'wlp3s0' \
+    --wifi_interface      'wlp3s0' \
+    --interval_bluetooth  5 \
+    --interval_net_wifi   5 \
+    --interval_disk_space 5 \
 | stdbuf -o L tee \
     >(stdbuf -o L "$BIN"/khatus_bar \
         -v Opt_Mpd_Song_Max_Chars=10 \
-        -v Opt_Net_Interfaces_To_Show=wlp3s0 \
         -v Opt_Pulseaudio_Sink=0 \
+        -v GC_Interval=1800 \
+        -f <("$BIN"/khatus_gen_bar_make_status \
+                -v Status_Fmt=' E=%s%% M=%d%% P=[%s %sr %sd %st %si %sz] C=[%s %s°C %srpm] D=[%s%% %s▲ %s▼] W=[%s %s▲ %s▼] B=%s *=%s%% (%s) [%s] %s°F %s ' \
+                -v Status_Args='@energy_percent,@memory_percent,@processes_count_all,@processes_count_r,@processes_count_d,@processes_count_t,@processes_count_i,@processes_count_z,@cpu_loadavg,@cpu_temp,@cpu_fan_speed,@disk_space,@disk_io_w,@disk_io_r,@net_wifi:wlp3s0,@net_io_w:wlp3s0,@net_io_r:wlp3s0,@bluetooth_power,@backlight_percent,@volume_pa_sink:0,@mpd,@weather_temp_f,@datetime' \
+            ) \
     | "$BIN"/khatus_actuate_status_bar_to_xsetroot_name \
     ) \
     >(stdbuf -o L "$BIN"/khatus_monitor_energy \
@@ -28,8 +47,14 @@ In my `~/.xinitrc` I have something like the following:
     >(stdbuf -o L "$BIN"/khatus_monitor_errors \
     | "$BIN"/khatus_actuate_alert_to_notify_send \
     ) \
+    >(stdbuf -o L "$BIN"/khatus_monitor_devices \
+    | "$BIN"/khatus_actuate_alert_to_notify_send \
+    ) \
+    >(stdbuf -o L "$BIN"/khatus_actuate_device_add_to_automount \
+    | "$BIN"/khatus_actuate_alert_to_notify_send \
+    ) \
 ) \
-2> >($BIN/twrap.sh >> $HOME/var/log/khatus/main.log) \
+2> >($BIN/twrap >> $KHATUS_LOGS_DIR/main.log) \
 1> /dev/null \
 &
 ```
@@ -168,6 +193,7 @@ controller, which are in turn actualized as desktop notifications by the
 TODO
 ----
 
+- formalize message format and protocol
 - tests (design is starting to take shape, so it is time)
 - show how many Debian package updates are available
 - show how many Debian package security-updates are available
@@ -224,11 +250,15 @@ Redesign notes
   intervals at runtime (which seems like a better idea than the above in-memory
   DB one).
 
-Ideas
------
+Idea grab bag
+-------------
 
+- track devices:
+    - alert when never before seen device is plugged-in
+    - report history and trends on when and how-often each
+      device/category is plugged-in, how-long it stays plaugged-in, etc.
 - daemonize `khatus`, so we don't have to re-launch `X11` to re-launch `khatus`
-- interoperate with other khatus instances
+- interoperate with other khatus nodes
     - prefix machine ID to each data source
       (What should that ID be? Hostname? Pub key?)
     - fetch remote data and process locally