Improved selection of actions to be performed

Added description of changes to docu

Author: gneiss15

boards.txt

@@ -192,8 +192,55 @@ in the specific subdirectory.  This mimics the POSIX behavior for
 directory traversal most C programmers are used to.
 
 
-Uploading files to file system
-------------------------------
+Uploading files to file system (new)
+------------------------------------
+
+Since PullRequest #8266 Filsystem generation is integrated into the
+“compile and/or upload” action of Arduino.
+There is no need to download any additional tool.
+
+This integration is done by adding 3 entries (“Upload”, "Filesystem" and “Export”)
+to the tools-menu. These entries are presented just like any other options
+for esp8266 (“Upload speed” ... “Non-32-Bit Access”) and placed right after
+the last.
+
+Menu-Entry “Upload” let You choose between:
+- Sketch
+- Filesystem
+- Both
+This Menu controls which parts are uploaded when You choose "Sketch->Upload"
+(Ctrl-U) from the Arduino Menu.
+
+Menu-Entry “Filesystem” let You choose between:
+- Off
+- LitteFs
+- SPIFFS
+This Menu controls which Fs will be created when You choose "Sketch->Compile"
+(Ctrl-R) from the Arduino Menu. The Fs will always be created inside the
+"export" dir (see below). 
+
+Menu-Entry “Export” let You choose between:
+- Off
+- .bin & .bin.signed)
+- Create & Export gzipped Binaries too
+This Menu controls export & generation of (extra) Sketch-Binaries.
+
+The "export" dir
+................
+After a (successful) compile, the files will be exported to a subdir
+“bin/{variant}” of Your sketch directory
+(“{variant}” replaced with the name of the board as shown behind
+“Tools -> Board:”).
+Signed variants of all Binaries are generated similar to the
+“automatic signing” done for normal sketch binary.
+
+As valid for the "old" tools mentioned below, it is nessesary to place
+files you want to be inside the generated file system into a directory
+named ``data`` inside Your sketch directory.
+
+
+Uploading files to file system (old tools)
+------------------------------------------
 
 *ESP8266FS* is a tool which integrates into the Arduino IDE. It adds a
 menu item to *Tools* menu for uploading the contents of sketch data

doc/filesystem.rst

@@ -131,7 +131,7 @@ recipe.objcopy.hex.2.pattern="{runtime.tools.python3.path}/python3" -I "{runtime
 recipe.objcopy.hex.3.pattern="{runtime.tools.python3.path}/python3" -I "{runtime.tools.sizes}" --elf "{build.path}/{build.project_name}.elf" --path "{runtime.tools.xtensa-lx106-elf-gcc.path}/bin" --mmu "{build.mmuflags}"
 
 # Post-Build: Handle new Menu-Enties: Filesystem & Binaries
-recipe.hooks.objcopy.postobjcopy.1.pattern="{runtime.tools.python3.path}/python3" -I "{runtime.tools.postbuild}" -fi "{build.Filesystem}" -bi "{build.Binaries}" -na "{build.project_name}" -bp "{build.path}" -so "{build.source.path}" -va "{build.variant}" -ss "{build.spiffs_start}" -se "{build.spiffs_end}" -sp "{build.spiffs_pagesize}" -sl "{build.spiffs_blocksize}"
+recipe.hooks.objcopy.postobjcopy.1.pattern="{runtime.tools.python3.path}/python3" -I "{runtime.tools.postbuild}" -fi "{build.Filesystem}" -ex "{build.Export}" -na "{build.project_name}" -bp "{build.path}" -so "{build.source.path}" -va "{build.variant}" -ss "{build.spiffs_start}" -se "{build.spiffs_end}" -sp "{build.spiffs_pagesize}" -sl "{build.spiffs_blocksize}"
 
 ## Save hex
 recipe.output.tmp_file.1={build.project_name}.bin
@@ -163,9 +163,9 @@ tools.esptool.upload.params.quiet=
 
 # Old behaviour (without integrated handling of filesystem & gzipd Binaries) can be (re)enabled by commenting in/out the following 2x2 entries
 #tools.esptool.upload.pattern="{cmd}" -I "{runtime.platform.path}/tools/upload.py" --chip esp8266 --port "{serial.port}" --baud "{upload.speed}" "{upload.verbose}" {upload.erase_cmd} {upload.resetmethod} write_flash 0x0 "{build.path}/{build.project_name}.bin"
-tools.esptool.upload.pattern="{cmd}" -I "{runtime.platform.path}/tools/uploadGn.py" -fi "{build.Filesystem}" --port "{serial.port}" --baud "{upload.speed}" {upload.resetmethod} --sk 0x0 "{build.path}/{build.project_name}.bin" --fs {build.spiffs_start} "{build.path}/{build.project_name}" {upload.erase_cmd} "{upload.verbose}"
+tools.esptool.upload.pattern="{cmd}" -I "{runtime.platform.path}/tools/uploadGn.py" -fi "{build.Filesystem}" -up "{build.Upload}" --port "{serial.port}" --baud "{upload.speed}" {upload.resetmethod} --sk 0x0 "{build.path}/{build.project_name}.bin" --fs {build.spiffs_start} "{build.path}/{build.project_name}" {upload.erase_cmd} "{upload.verbose}"
 #tools.esptool.upload.network_pattern="{network_cmd}" -I "{runtime.platform.path}/tools/espota.py" -i "{serial.port}" -p "{network.port}" "--auth={network.password}" -f "{build.path}/{build.project_name}.bin"
-tools.esptool.upload.network_pattern="{network_cmd}" -I "{runtime.platform.path}/tools/netUploadGn.py" -fi "{build.Filesystem}" -i "{serial.port}" -p "{network.port}" "--auth={network.password}" --sk "{build.path}/{build.project_name}.bin" --fs "{build.path}/{build.project_name}"
+tools.esptool.upload.network_pattern="{network_cmd}" -I "{runtime.platform.path}/tools/netUploadGn.py" -fi "{build.Filesystem}" -up "{build.Upload}" -i "{serial.port}" -p "{network.port}" "--auth={network.password}" --sk "{build.path}/{build.project_name}.bin" --fs "{build.path}/{build.project_name}"
 
 tools.mkspiffs.cmd=mkspiffs
 tools.mkspiffs.cmd.windows=mkspiffs.exe

platform.txt

@@ -1033,23 +1033,26 @@
         ( '.build.debug_port', '' ),
         ( '.build.debug_level', '' ),
 
+        ( '.menu.Upload.Sketch', 'Sketch' ),
+        ( '.menu.Upload.Sketch.build.Upload', '1' ),
+        ( '.menu.Upload.Filesystem', 'Filesystem' ),
+        ( '.menu.Upload.Filesystem.build.Upload', '2' ),
+        ( '.menu.Upload.Both', 'Both' ),
+        ( '.menu.Upload.Both.build.Upload', '3' ),
+
         ( '.menu.Filesystem.Off', 'Off' ),
         ( '.menu.Filesystem.Off.build.Filesystem', '0' ),
-        ( '.menu.Filesystem.LitteFsCreateUpload', 'LitteFs: Create & Upload' ),
-        ( '.menu.Filesystem.LitteFsCreateUpload.build.Filesystem', '1' ),
-        ( '.menu.Filesystem.LitteFsCreateExport', 'LitteFs: Create only' ),
-        ( '.menu.Filesystem.LitteFsCreateExport.build.Filesystem', '2' ),
-        ( '.menu.Filesystem.SPIFFSCreateUpload', 'SPIFFS: Create & Upload' ),
-        ( '.menu.Filesystem.SPIFFSCreateUpload.build.Filesystem', '3' ),
-        ( '.menu.Filesystem.SPIFFSCreateExport', 'SPIFFS: Create only' ),
-        ( '.menu.Filesystem.SPIFFSCreateExport.build.Filesystem', '4' ),
-
-        ( '.menu.Binaries.Off', 'Off' ),
-        ( '.menu.Binaries.Off.build.Binaries', '0' ),
-        ( '.menu.Binaries.Binaries', 'Export (.bin & .bin.signed)' ),
-        ( '.menu.Binaries.Binaries.build.Binaries', '1' ),
-        ( '.menu.Binaries.PackedBinaries', 'Create & Export gzipped Binaries too' ),
-        ( '.menu.Binaries.PackedBinaries.build.Binaries', '2' ),
+        ( '.menu.Filesystem.LitteFs', 'LitteFs' ),
+        ( '.menu.Filesystem.LitteFs.build.Filesystem', '1' ),
+        ( '.menu.Filesystem.SPIFFS', 'SPIFFS' ),
+        ( '.menu.Filesystem.SPIFFS.build.Filesystem', '2' ),
+
+        ( '.menu.Export.Off', 'Off' ),
+        ( '.menu.Export.Off.build.Export', '0' ),
+        ( '.menu.Export.Binaries', '.bin & .bin.signed' ),
+        ( '.menu.Export.Binaries.build.Export', '1' ),
+        ( '.menu.Export.GzBinaries', 'Create & Export gzipped Binaries too' ),
+        ( '.menu.Export.GzBinaries.build.Export', '2' ),
         ]),
 
     #######################
@@ -1676,8 +1679,9 @@ def all_boards ():
     print('menu.ssl=SSL Support')
     print('menu.mmu=MMU')
     print('menu.non32xfer=Non-32-Bit Access')
+    print('menu.Upload=Upload')
     print('menu.Filesystem=Filesystem')
-    print('menu.Binaries=Binaries')
+    print('menu.Export=Export')
     print('')
 
     missingboards = []

tools/boards.txt.py

@@ -15,8 +15,8 @@
 
 def parse_args( argsIn ):
     parser = argparse.ArgumentParser( description = 'PostBuild for ESP8288' )
-    parser.add_argument( '-fi', '--Filesystem', type = int, default = 0, help = '0: Off, 1: LitteFs: Create & Upload, 2: LitteFs: Create only, 3: SPIFFS: Create & Upload, 4: SPIFFS: Create only' )
-    parser.add_argument( '-bi', '--Binaries', type = int, default = 0, help = '0: Off, 1: Export (.bin & .bin.signed), 2: Create & Export gzipped Binaries too' )
+    parser.add_argument( '-fi', '--Filesystem', type = int, default = 0, help = '0: Off, 1: LitteFs, 3: SPIFFS' )
+    parser.add_argument( '-ex', '--Export', type = int, default = 0, help = '0: Off, 1: .bin & .bin.signed, 2: Create & Export gzipped Binaries too' )
     parser.add_argument( '-na', '--name', type = str, required = True, help = 'Name of sketch (without extension)' )
     parser.add_argument( '-bp', '--buildPath', type = str, required = True, help = 'Path to temporary dir where sketch was build' )
     parser.add_argument( '-so', '--source', type = str, required = True, help = 'Path to sketch' )
@@ -71,11 +71,21 @@ def CreateSignedFile( dir, name ):
         raise FatalError( "Exception while signing '%s': %s" % ( name, e ) )
     return []
 
+def RemoveFs( fsName ):
+    """ Removes the (possible existing from prev. builds) given fs from {build.path}
+        This enshures, that (at upload-stage) we don't use the wrong fs created formerly.
+        fsName = "littlefs" "spiffs"           used for naming the binary to remove. """
+    imageName = "./%s.%s" % ( Args.name, fsName )
+    if os.path.exists( imageName ):
+        os.remove( imageName )
+
 def CreateFs( fsName, mkFsName ):
     """ Creates the given fs from all files inside subdir 'data' of the sketch. 
         fsName = "littlefs" "spiffs"           used for naming the generated binary.
         mkFsName = "mklittlefs" | "mkspiffs"   the name of the programm that generates the fs """
     mkFsPath = Which( mkFsName, os.path.join( ToolsDir, mkFsName ) )
+    if mkFsPath is None:
+        mkFsPath = Which( "%s.exe" % mkFsName, os.path.join( ToolsDir, mkFsName ) )
     res = []
     dataDir = "%s/data" % ( Args.source )
     if len( Args.spiffs_start ) == 0 or len( Args.spiffs_end ) == 0:
@@ -107,7 +117,7 @@ def CreateFs( fsName, mkFsName ):
     signing = Signing and os.path.exists( os.path.abspath( Args.name + ".bin.signed" ) )
     if signing:
         res += CreateSignedFile( DstDir, imageName )
-    if Args.Binaries == 2:
+    if Args.Export == 2:
         res += CreateGzFile( DstDir, imageName )
         if signing:
             res += CreateSignedFile( DstDir, "%s.%s.gz" % ( Args.name, fsName ) )
@@ -116,18 +126,20 @@ def CreateFs( fsName, mkFsName ):
 def ProcessFilesystem_():
     if Args.spiffs_start is None or Args.spiffs_end is None:
         raise ProcessError( "'spiffs_start' and/or 'spiffs_end' missing" )
-    if Args.Filesystem == 1 or Args.Filesystem == 2:
+    if Args.Filesystem == 1:
+        RemoveFs( "spiffs" )
         return CreateFs( "littlefs", "mklittlefs" )
-    elif Args.Filesystem == 3 or Args.Filesystem == 4:
+    elif Args.Filesystem == 2:
+        RemoveFs( "littlefs" )
         return CreateFs( "spiffs", "mkspiffs" )
 
-def ProcessBinaries_():
+def ProcessExport_():
     res = []
     os.makedirs( DstDir, exist_ok = True )
     # Copy Binaries
     res += CopyToDir( Args.name, "bin", DstDir )
     res += CopyToDir( Args.name, "bin.signed", DstDir )
-    if Args.Binaries == 2:
+    if Args.Export == 2:
         # Create & Export gzipped Binaries too
         res += CreateGzFile( DstDir, "%s.bin" % Args.name )
         if os.path.exists( os.path.abspath( os.path.join( DstDir, "%s.bin.signed" % Args.name ) ) ):
@@ -141,10 +153,14 @@ def ProcessFilesystem():
         Msg( '...files generated: %s' % ", ".join( filesCreated ) )
     except ProcessError as e:
         Msg( '...aborted: %s' % e )
+        try:
+            WarningDialog( "Filesystem Create aborted", e )
+        except ProcessError:
+            pass
 
-def ProcessBinaries():
+def ProcessExport():
     Msg( "Exporting Binaries..." )
-    filesExported = ProcessBinaries_()
+    filesExported = ProcessExport_()
     Msg( '...files exported: %s' % ", ".join( filesExported ) )
 
 def main( argsIn = None ):
@@ -157,7 +173,7 @@ def main( argsIn = None ):
 
     #Debug( "Python-Path: %s" % sys.executable ) 
     parse_args( argsIn )
-    #Debug( "Args: %s" % ", "join( sys.argv[ 1: ] ) )
+    #Debug( "Posbuild: Args: %s" % ", ".join( sys.argv[ 1: ] ) )
 
     #!! For unknown reason using/concatinig Args.buildPath with "/" (or enything else) will result in an empthy string ???
     #if You uncomment the following two lines You will see something like:
@@ -169,6 +185,7 @@ def main( argsIn = None ):
     # Workaround: cd to the build/temp path
     cwd = os.getcwd()
     os.chdir( Args.buildPath )
+    Msg( 'Build-Dir: %s\n' % Args.buildPath )
 
     #!	 Even this will not give the correct path !
     #Debug( "abspath: %s" % os.path.abspath( "./" ) )
@@ -179,10 +196,13 @@ def main( argsIn = None ):
         SigningPrivKeyPath = os.path.abspath( "%s/private.key" % Args.source )
         Signing = os.path.isfile( SigningPrivKeyPath )
         DstDir = os.path.join( Args.source, "bin", Args.variant )
-        if Args.Filesystem != 0:
+        if Args.Filesystem == 0:
+            RemoveFs( "littlefs" )
+            RemoveFs( "spiffs" )
+        else:
             ProcessFilesystem()
-        if Args.Binaries != 0:
-            ProcessBinaries()
+        if Args.Export != 0:
+            ProcessExport()
     finally:
         # restore working dir    
         os.chdir( cwd )

tools/postbuild.py

@@ -37,7 +37,8 @@
 #Args: (new)
 #  As defined in 'platform.txt' for 'tools.esptool.upload.pattern'  possible values
 #  |                                                                |
-#  -fi "{build.Filesystem}"                                         0-4
+#  -up "{build.Upload}"                                             1-3
+#  -fi "{build.Filesystem}"                                         0-2
 #  --port "{serial.port}"                                           e.g.: /dev/ttyUSB0
 #  --baud "{upload.speed}"                                          e.g.: 115200
 #  {upload.resetmethod}                                             --before { default_reset | no_reset | no_reset_no_sync } --after { hard_reset | soft_reset }
@@ -50,7 +51,8 @@
 
 def parse_args( argsIn ):
     parser = argparse.ArgumentParser( description = 'Upload-Wrapper for Arduino esp8266' )
-    parser.add_argument( '-fi', '--Filesystem', type = int, default = 0, help = '0: Off, 1: LitteFs: Create & Upload, 2: LitteFs: Create only, 3: SPIFFS: Create & Upload, 4: SPIFFS: Create only' )
+    parser.add_argument( '-up', '--Upload', type = int, default = 1, help = '1: Sketch, 2: Filesystem, 3: Both' )
+    parser.add_argument( '-fi', '--Filesystem', type = int, default = 0, help = '0: Off, 1: LitteFs, 3: SPIFFS' )
     parser.add_argument( '--port', type = str, required = True, help = 'path to serial device' )
     parser.add_argument( '--baud', type = str, required = True, help = 'baudrate' )
     parser.add_argument( '--before', type = str, required = True, help = 'before (default_reset/no_reset/no_reset_no_sync)' )
@@ -87,27 +89,29 @@ def main( argsIn = None ):
         esptoolArgs += [ '--trace' ]
     esptoolArgs += [ 'write_flash' ]
 
-    if len( Args.erase_cmd ) and Args.erase_cmd[ 0 ] == "erase_flash":
-        esptoolArgs += [ '--erase-all' ]
-    esptoolArgs += [ '--flash_size', 'detect', Args.sk[ 0 ], Args.sk[ 1 ] ]
-    
     EraseFilePath = ''
+    filesUploaded = []
     try:
-        if len( Args.erase_cmd ) and Args.erase_cmd[ 0 ] == "erase_region":
-            # Generate temporary empty (0xff) file
-            f, EraseFilePath = tempfile.mkstemp()
-            os.write( f, bytearray( [ 255 ] * int( Args.erase_cmd[ 2 ], 0 ) ) )
-            os.close( f )
-            esptoolArgs += [ Args.erase_cmd[ 1 ], EraseFilePath ]
-
-        filesUploaded = [ Path( Args.sk[ 1 ] ).name ]
-        if Args.Filesystem == 1:
-            esptoolArgs += [ Args.fs[ 0 ], "%s.littlefs" % Args.fs[ 1 ] ]
-            filesUploaded += [ Path( Args.fs[ 1 ] ).name ]
-        elif Args.Filesystem == 3:
-            esptoolArgs += [ Args.fs[ 0 ], "%s.spiffs" % Args.fs[ 1 ] ]
-            filesUploaded += [ Path( Args.fs[ 1 ] ).name ]
-    
+        if ( Args.Upload & 1 ) == 1:
+            if len( Args.erase_cmd ) and Args.erase_cmd[ 0 ] == "erase_flash":
+                esptoolArgs += [ '--erase-all' ]
+            esptoolArgs += [ '--flash_size', 'detect', Args.sk[ 0 ], Args.sk[ 1 ] ]
+
+            if len( Args.erase_cmd ) and Args.erase_cmd[ 0 ] == "erase_region":
+                # Generate temporary empty (0xff) file
+                f, EraseFilePath = tempfile.mkstemp()
+                os.write( f, bytearray( [ 255 ] * int( Args.erase_cmd[ 2 ], 0 ) ) )
+                os.close( f )
+                esptoolArgs += [ Args.erase_cmd[ 1 ], EraseFilePath ]
+
+            filesUploaded += [ Path( Args.sk[ 1 ] ).name ]
+
+        if ( Args.Upload & 2 ) == 2:
+            fsName = "%s.%s" % ( Args.fs[ 1 ], "littlefs" if Args.Filesystem == 1 else "spiffs" )
+            if os.path.exists( fsName ):
+                esptoolArgs += [ Args.fs[ 0 ], fsName ]
+                filesUploaded += [ Path( fsName ).name ]
+
         Msg( "Uploading Binaries..." )
         #Debug( str( esptoolArgs ) )
         esptool.main( esptoolArgs )

tools/uploadGn.py

@@ -75,8 +75,8 @@ def RemoveIno( path ):
     if path[ -4: ] == ".ino":
         path = name[ 0:-4 ]
     return path
-    
-def ConfirmDialog( title, text ):
+
+def TkDialog( title, text, mbName ):
     try:
         import tkinter
         from tkinter import messagebox
@@ -86,5 +86,24 @@ def ConfirmDialog( title, text ):
     rootWin.overrideredirect( 1 ) # Avoid it appearing and then disappearing quickly
     #rootWin.iconbitmap("PythonIcon.ico") # Set an icon (this is optional - must be in a .ico format)
     rootWin.withdraw() # Hide the window as we do not want to see this one
-    return messagebox.askyesno( title, text, parent = rootWin )
+    mbFunc = getattr( messagebox, mbName ) 
+    return mbFunc( title, text, parent = rootWin )
+def InfoDialog( title, text ):
+    return TkDialog( title, text, 'showinfo' )
+def WarningDialog( title, text ):
+    return TkDialog( title, text, 'showwarning' )
+def ErrorDialog( title, text ):
+    return TkDialog( title, text, 'showerror' )
+def QuestionDialog( title, text ):
+    return TkDialog( title, text, 'askquestion' )
+def OkCancelDialog( title, text ):
+    return TkDialog( title, text, 'askokcancel' )
+def RetryCancelDialog( title, text ):
+    return TkDialog( title, text, 'askretrycancel' )
+def YesNoDialog( title, text ):
+    return TkDialog( title, text, 'askyesno' )
+def ConfirmDialog( title, text ):
+    return TkDialog( title, text, 'askyesno' )
+def YesNoCancelDialog( title, text ):
+    return TkDialog( title, text, 'askyesnocancel' )