From 5785c4cea4eb1c4c5b42ed83b29a390e08060f30 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Thu, 18 Oct 2018 14:42:55 +0200
Subject: add --help option

---
 bin/msp430-etv | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

diff --git a/bin/msp430-etv b/bin/msp430-etv
index 8ed0c4f..b3eb2b6 100755
--- a/bin/msp430-etv
+++ b/bin/msp430-etv
@@ -20,15 +20,49 @@ def measure_data(time):
 
 	return res.stdout
 
+def show_help():
+	print('''msp430-etv - MSP430 EnergyTrace Visualizer
+
+USAGE
+
+msp430-etv [--load <file> | <measurement duration>] [--save <file>]
+	[--skip <count>] [--plot] [--stat]
+
+DESCRIPTION
+
+msp430-etv takes energy measurements from an MSP430 Launchpad or similar device
+using MSP430 EnergyTrace technology. Measurements can be taken directly (by
+specifying <measurement duration> in seconds) or loaded from a logfile using
+--load <file>. Data can be plotted or aggregated on stdout.
+
+OPTIONS
+
+  --load <file>
+    Load data from <file>
+  --save <file>
+    Save measurement data in <file>
+  --skip <count>
+    Skip <count> data samples. This is useful to avoid startup code
+    influencing the results of a long-running measurement
+  --plot
+    Show power/time plot
+  --stat
+    Show mean voltage, current, and power as well as total energy consumption.
+	''')
+
 if __name__ == '__main__':
 	try:
-		optspec = ('load= save= skip= plot stat')
+		optspec = ('help load= save= skip= plot stat')
 		raw_opts, args = getopt.getopt(sys.argv[1:], "", optspec.split(' '))
 
 		for option, parameter in raw_opts:
 			optname = re.sub(r'^--', '', option)
 			opt[optname] = parameter
 
+		if 'help' in opt:
+			show_help()
+			sys.exit(0)
+
 		if not 'load' in opt:
 			duration = int(args[0])
 
-- 
cgit v1.2.3