add SPIFFS flashing over the air

tools/espota.py

@@ -1,45 +1,63 @@
 #!/usr/bin/env python
 #
-# this script will push an OTA update to the ESP
-# use it like: python espota.py <ESP_IP_address> <sketch.bin>
+# Original espoty.py comes from ...?
+#
+# Modified since 2015-09-18 from Pascal Gollor (https://github.com/pgollor)
+#
+# This script will push an OTA update to the ESP
+# use it like: python espota.py -i <ESP_IP_address> -p <ESP_port> -f <sketch.bin>
+#
+# Changes
+# 2015-09-18:
+# - Add option parser.
+# - Add logging.
+# - Send command to controller to differ between flashing and transmitting SPIFFS image.
+#
  
 from __future__ import print_function
 import socket
 import sys
 import os
+import optparse
+import logging
+
+# Commands
+FLASH = 0
+SPIFFS = 100
+
  
-def serve(remoteAddr, remotePort, filename):
+def serve(remoteAddr, remotePort, filename, command = FLASH):
   # Create a TCP/IP socket
   sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
   serverPort = 48266
   server_address = ('0.0.0.0', serverPort)
-  print('Starting on %s:%s' % server_address, file=sys.stderr)
+  logging.info('Starting on %s:%s', str(server_address[0]), str(server_address[1]))
   try:
     sock.bind(server_address)
     sock.listen(1)
   except:
-    print('Listen Failed', file=sys.stderr)
+    logging.error("Listen Failed")
     return 1
  
   content_size = os.path.getsize(filename)
-  print('Upload size: %d' % content_size, file=sys.stderr)
-  message = '%d %d %d\n' % (0, serverPort, content_size)
+  logging.info('Upload size: %d', content_size)
+  message = '%d %d %d\n' % (command, serverPort, content_size)
  
   # Wait for a connection
-  print('Sending invitation to:', remoteAddr, file=sys.stderr)
+  logging.info('Sending invitation to: %s', remoteAddr)
   sock2 = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
   remote_address = (remoteAddr, int(remotePort))
   sent = sock2.sendto(message, remote_address)
   sock2.close()
   
-  print('Waiting for device...\n', file=sys.stderr)
+  logging.info('Waiting for device...\n')
   try:
     sock.settimeout(10)
     connection, client_address = sock.accept()
     sock.settimeout(None)
     connection.settimeout(None)
   except:
-    print('No response from device', file=sys.stderr)
+    logging.error('No response from device')
     sock.close()
     return 1
 
@@ -57,23 +75,23 @@ def serve(remoteAddr, remotePort, filename):
         connection.sendall(chunk)
         res = connection.recv(4)
       except:
-        print('\nError Uploading', file=sys.stderr)
+        logging.error('\nError Uploading')
         connection.close()
         f.close()
         sock.close()
         return 1
 
-    print('\nWaiting for result...\n', file=sys.stderr)
+    logging.info('\nWaiting for result...\n')
     try:
       connection.settimeout(60)
       data = connection.recv(32)
-      print('Result: %s' % data, file=sys.stderr)
+      logging.info('Result: %s' ,data)
       connection.close()
       f.close()
       sock.close()
       return 0
     except:
-      print('Result: No Answer!', file=sys.stderr)
+      logging.error('Result: No Answer!')
       connection.close()
       f.close()
       sock.close()
@@ -85,12 +103,94 @@ def serve(remoteAddr, remotePort, filename):
 
   sock.close()
   return 1
- 
+# end serve
+
+
+def parser():
+	parser = optparse.OptionParser(
+		usage = "%prog [options]",
+		description = "Transmit image over the air to the esp8266 module with OTA support."
+	)
+
+	# destination ip and port
+	group = optparse.OptionGroup(parser, "Destination")
+	group.add_option("-i", "--ip",
+		dest = "esp_ip",
+		action = "store",
+		help = "ESP8266 IP Address.",
+		default = False
+	)
+	group.add_option("-p", "--port",
+		dest = "esp_port",
+		type = "int",
+		help = "ESP8266 ota Port.",
+		default = 8266
+	)
+	parser.add_option_group(group)
+
+	# image
+	group = optparse.OptionGroup(parser, "Image")
+	group.add_option("-f", "--file",
+		dest = "image",
+		help = "Image file.",
+		metavar="FILE",
+		default = None
+	)
+	group.add_option("-s", "--spiffs",
+		dest = "spiffs",
+		action = "store_true",
+		help = "Use this option to transmit a SPIFFS image and do not flash the module.",
+		default = False
+	)
+	parser.add_option_group(group)
+
+	# output group
+	group = optparse.OptionGroup(parser, "Output")
+	group.add_option("-d", "--debug",
+		dest = "debug",
+		help = "Show debug output. And override loglevel with debug.",
+		action = "store_true",
+		default = False
+	)
+	parser.add_option_group(group)
+
+	(options, args) = parser.parse_args()
+
+	return options
+# end parser
+
+
 def main(args):
-  return serve(args[1], args[2], args[3])
- 
- 
- 
+	# get options
+	options = parser()
+
+	# adapt log level
+	loglevel = logging.WARNING
+	if (options.debug):
+		loglevel = logging.DEBUG
+	# end if
+
+	# logging
+	logging.basicConfig(level = loglevel, format = '%(asctime)-8s [%(levelname)s]: %(message)s', datefmt = '%H:%M:%S')
+
+	logging.debug("Options: %s", str(options))
+
+	# check options
+	if (not options.esp_ip or not options.image):
+		logging.critical("Not enough arguments.")
+
+		return 1
+	# end if
+
+	command = FLASH
+	if (options.spiffs):
+		command = SPIFFS
+	# end if
+
+	return serve(options.esp_ip, options.esp_port, options.image, command)
+# end main
+
+
 if __name__ == '__main__':
-  sys.exit(main(sys.argv))
- 
+	sys.exit(main(sys.argv))
+# end if